solargraph 0.52.0 → 0.53.0

data/lib/solargraph/rbs_map/conversions.rb

@@ -27,7 +27,7 @@ module Solargraph
 
       private
 
-      # @return Hash{String => RBS::AST::Declarations::TypeAlias}
+      # @return [Hash{String => RBS::AST::Declarations::TypeAlias}]
       def type_aliases
         @type_aliases ||= {}
       end
@@ -42,7 +42,7 @@ module Solargraph
         add_back_implicit_pins(added_pins)
       end
 
-      # @param added_pins [Range<Pin>]
+      # @param added_pins [::Enumerable<Pin>]
       # @return [void]
       def add_back_implicit_pins(added_pins)
         added_pins.each do |pin|
@@ -68,7 +68,7 @@ module Solargraph
           class_decl_to_pin decl
         when RBS::AST::Declarations::Interface
           # STDERR.puts "Skipping interface #{decl.name.relative!}"
-          interface_decl_to_pin decl
+          interface_decl_to_pin decl, closure
         when RBS::AST::Declarations::TypeAlias
           type_aliases[decl.name.to_s] = decl
         when RBS::AST::Declarations::Module
@@ -77,16 +77,46 @@ module Solargraph
           constant_decl_to_pin decl
         when RBS::AST::Declarations::ClassAlias
           class_alias_decl_to_pin decl
+        when RBS::AST::Declarations::ModuleAlias
+          module_alias_decl_to_pin decl
+        when RBS::AST::Declarations::Global
+          global_decl_to_pin decl
         else
-          Solargraph.logger.info "Skipping declaration #{decl.class}"
+          Solargraph.logger.warn "Skipping declaration #{decl.class}"
         end
       end
 
-      def convert_members_to_pin decl, closure
+      # @param decl [RBS::AST::Declarations::Module]
+      # @param module_pin [Pin::Namespace]
+      # @return [void]
+      def convert_self_types_to_pins decl, module_pin
+        decl.self_types.each { |self_type| context = convert_self_type_to_pins(self_type, module_pin) }
+      end
+
+      # @param decl [RBS::AST::Declarations::Module::Self]
+      # @param closure [Pin::Namespace]
+      # @return [void]
+      def convert_self_type_to_pins decl, closure
+        include_pin = Solargraph::Pin::Reference::Include.new(
+          name: decl.name.relative!.to_s,
+          location: rbs_location_to_location(decl.location),
+          closure: closure
+        )
+        pins.push include_pin
+      end
+
+      # @param decl [RBS::AST::Declarations::Module,RBS::AST::Declarations::Class,RBS::AST::Declarations::Interface]
+      # @param closure [Pin::Namespace]
+      # @return [void]
+      def convert_members_to_pins decl, closure
         context = Context.new
         decl.members.each { |m| context = convert_member_to_pin(m, closure, context) }
       end
 
+      # @param member [RBS::AST::Members::Base,RBS::AST::Declarations::Base]
+      # @param closure [Pin::Namespace]
+      # @param context [Context]
+      # @return [void]
       def convert_member_to_pin member, closure, context
         case member
         when RBS::AST::Members::MethodDefinition
@@ -105,6 +135,10 @@ module Solargraph
           extend_to_pin(member, closure)
         when RBS::AST::Members::Alias
           alias_to_pin(member, closure)
+        when RBS::AST::Members::ClassInstanceVariable
+          civar_to_pin(member, closure)
+        when RBS::AST::Members::ClassVariable
+          cvar_to_pin(member, closure)
         when RBS::AST::Members::InstanceVariable
           ivar_to_pin(member, closure)
         when RBS::AST::Members::Public
@@ -114,7 +148,7 @@ module Solargraph
         when RBS::AST::Declarations::Base
           convert_decl_to_pin(member, closure)
         else
-          Solargraph.logger.warn "Skipping member #{member.class}"
+          Solargraph.logger.warn "Skipping member type #{member.class}"
         end
         context
       end
@@ -127,6 +161,9 @@ module Solargraph
           name: decl.name.relative!.to_s,
           closure: Solargraph::Pin::ROOT_PIN,
           comments: decl.comment&.string,
+          # @todo some type parameters in core/stdlib have default
+          #   values; Solargraph doesn't support that yet as so these
+          #   get treated as undefined if not specified
           generics: decl.type_params.map(&:name).map(&:to_s)
         )
         pins.push class_pin
@@ -136,24 +173,27 @@ module Solargraph
             name: decl.super_class.name.relative!.to_s
           )
         end
-        convert_members_to_pin decl, class_pin
+        add_mixins decl, class_pin.closure
+        convert_members_to_pins decl, class_pin
       end
 
       # @param decl [RBS::AST::Declarations::Interface]
+      # @param closure [Pin::Closure]
       # @return [void]
-      def interface_decl_to_pin decl
+      def interface_decl_to_pin decl, closure
         class_pin = Solargraph::Pin::Namespace.new(
           type: :module,
           name: decl.name.relative!.to_s,
           closure: Solargraph::Pin::ROOT_PIN,
           comments: decl.comment&.string,
+          generics: decl.type_params.map(&:name).map(&:to_s),
           # HACK: Using :hidden to keep interfaces from appearing in
           # autocompletion
           visibility: :hidden
         )
         class_pin.docstring.add_tag(YARD::Tags::Tag.new(:abstract, '(RBS interface)'))
         pins.push class_pin
-        convert_members_to_pin decl, class_pin
+        convert_members_to_pins decl, class_pin
       end
 
       # @param decl [RBS::AST::Declarations::Module]
@@ -167,15 +207,19 @@ module Solargraph
           generics: decl.type_params.map(&:name).map(&:to_s),
         )
         pins.push module_pin
-        convert_members_to_pin decl, module_pin
+        convert_self_types_to_pins decl, module_pin
+        convert_members_to_pins decl, module_pin
+
+        add_mixins decl, module_pin.closure
       end
 
       # @param name [String]
       # @param tag [String]
       # @param comments [String]
+      # @param base [String, nil] Optional conversion of tag to base<tag>
       #
       # @return [Solargraph::Pin::Constant]
-      def create_constant(name, tag, comments)
+      def create_constant(name, tag, comments, base = nil)
         parts = name.split('::')
         if parts.length > 1
           name = parts.last
@@ -189,8 +233,8 @@ module Solargraph
           closure: closure,
           comments: comments
         )
-        # @todo Class or Module?
-        constant_pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', "Class<#{tag}>"))
+        tag = "#{base}<#{tag}>" if base
+        constant_pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', tag))
         constant_pin
       end
 
@@ -201,7 +245,17 @@ module Solargraph
         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)
+        pins.push create_constant(new_name, old_name, decl.comment&.string, 'Class')
+      end
+
+      # @param decl [RBS::AST::Declarations::ModuleAlias]
+      # @return [void]
+      def module_alias_decl_to_pin decl
+        # See https://www.rubydoc.info/gems/rbs/3.4.3/RBS/AST/Declarations/ModuleAlias
+        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, 'Module')
       end
 
       # @param decl [RBS::AST::Declarations::Constant]
@@ -211,17 +265,40 @@ module Solargraph
         pins.push create_constant(decl.name.relative!.to_s, tag, decl.comment&.string)
       end
 
+      # @param decl [RBS::AST::Declarations::Global]
+      # @return [void]
+      def global_decl_to_pin decl
+        closure = Solargraph::Pin::ROOT_PIN
+        name = decl.name.to_s
+        tag = other_type_to_tag(decl.type)
+        pin = Solargraph::Pin::GlobalVariable.new(
+          name: name,
+          closure: closure,
+          comments: decl.comment&.string,
+        )
+        pin.docstring.add_tag(YARD::Tags::Tag.new(:type, '', tag))
+        pins.push pin
+      end
+
       # @param decl [RBS::AST::Members::MethodDefinition]
       # @param closure [Pin::Closure]
       # @return [void]
       def method_def_to_pin decl, closure
+        # there may be edge cases here around different signatures
+        # having different type params / orders - we may need to match
+        # this data model and have generics live in signatures to
+        # handle those correctly
+        generics = decl.overloads.map(&:method_type).flat_map(&:type_params).map(&:name).map(&:to_s).uniq
         if decl.instance?
           pin = Solargraph::Pin::Method.new(
             name: decl.name.to_s,
             closure: closure,
             comments: decl.comment&.string,
             scope: :instance,
-            signatures: []
+            signatures: [],
+            generics: generics,
+            # @todo RBS core has unreliable visibility definitions
+            visibility: closure.path == 'Kernel' && Kernel.private_instance_methods(false).include?(decl.name) ? :private : :public
           )
           pin.signatures.concat method_def_to_sigs(decl, pin)
           pins.push pin
@@ -237,6 +314,7 @@ module Solargraph
             pins.last.signatures.replace(
               pin.signatures.map do |p|
                 Pin::Signature.new(
+                  p.generics,
                   p.parameters,
                   ComplexType::SELF
                 )
@@ -253,7 +331,8 @@ module Solargraph
             closure: closure,
             comments: decl.comment&.string,
             scope: :class,
-            signatures: []
+            signatures: [],
+            generics: generics
           )
           pin.signatures.concat method_def_to_sigs(decl, pin)
           pins.push pin
@@ -262,17 +341,33 @@ module Solargraph
 
       # @param decl [RBS::AST::Members::MethodDefinition]
       # @param pin [Pin::Method]
+      # @return [void]
       def method_def_to_sigs decl, pin
         decl.overloads.map do |overload|
+          generics = overload.method_type.type_params.map(&:to_s)
           parameters, return_type = parts_of_function(overload.method_type, pin)
           block = if overload.method_type.block
-                    Pin::Signature.new(*parts_of_function(overload.method_type.block, pin))
+                    Pin::Signature.new(generics, *parts_of_function(overload.method_type.block, pin))
           end
           return_type = ComplexType.try_parse(method_type_to_tag(overload.method_type))
-          Pin::Signature.new(parameters, return_type, block)
+          Pin::Signature.new(generics, parameters, return_type, block)
         end
       end
 
+      # @param location [RBS::Location, nil]
+      # @return [Solargraph::Location, nil]
+      def rbs_location_to_location(location)
+        return nil if location&.name.nil?
+
+        start_pos = Position.new(location.start_line - 1, location.start_column)
+        end_pos = Position.new(location.end_line - 1, location.end_column)
+        range = Range.new(start_pos, end_pos)
+        Location.new(location.name, range)
+      end
+
+      # @param type [RBS::MethodType,RBS::Types::Block]
+      # @param pin [Pin::Method]
+      # @return [Array<Array<Pin::Parameter>, ComplexType>]
       def parts_of_function type, pin
         return [[Solargraph::Pin::Parameter.new(decl: :restarg, name: 'arg', closure: pin)], ComplexType.try_parse(method_type_to_tag(type))] if defined?(RBS::Types::UntypedFunction) && type.type.is_a?(RBS::Types::UntypedFunction)
 
@@ -313,6 +408,9 @@ module Solargraph
         [parameters, return_type]
       end
 
+      # @param decl [RBS::AST::Members::AttrReader,RBS::AST::Members::AttrAccessor]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def attr_reader_to_pin(decl, closure)
         pin = Solargraph::Pin::Method.new(
           name: decl.name.to_s,
@@ -325,6 +423,9 @@ module Solargraph
         pins.push pin
       end
 
+      # @param decl [RBS::AST::Members::AttrWriter, RBS::AST::Members::AttrAccessor]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def attr_writer_to_pin(decl, closure)
         pin = Solargraph::Pin::Method.new(
           name: "#{decl.name.to_s}=",
@@ -337,11 +438,17 @@ module Solargraph
         pins.push pin
       end
 
+      # @param decl [RBS::AST::Members::AttrAccessor]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def attr_accessor_to_pin(decl, closure)
         attr_reader_to_pin(decl, closure)
         attr_writer_to_pin(decl, closure)
       end
 
+      # @param decl [RBS::AST::Members::InstanceVariable]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def ivar_to_pin(decl, closure)
         pin = Solargraph::Pin::InstanceVariable.new(
           name: decl.name.to_s,
@@ -352,13 +459,50 @@ module Solargraph
         pins.push pin
       end
 
+      # @param decl [RBS::AST::Members::ClassVariable]
+      # @param closure [Pin::Namespace]
+      # @return [void]
+      def cvar_to_pin(decl, closure)
+        name = decl.name.to_s
+        pin = Solargraph::Pin::ClassVariable.new(
+          name: name,
+          closure: closure,
+          comments: decl.comment&.string
+        )
+        pin.docstring.add_tag(YARD::Tags::Tag.new(:type, '', other_type_to_tag(decl.type)))
+        pins.push pin
+      end
+
+      # @param decl [RBS::AST::Members::ClassInstanceVariable]
+      # @param closure [Pin::Namespace]
+      # @return [void]
+      def civar_to_pin(decl, closure)
+        name = decl.name.to_s
+        pin = Solargraph::Pin::InstanceVariable.new(
+          name: name,
+          closure: closure,
+          comments: decl.comment&.string
+        )
+        pin.docstring.add_tag(YARD::Tags::Tag.new(:type, '', other_type_to_tag(decl.type)))
+        pins.push pin
+      end
+
+      # @param decl [RBS::AST::Members::Include]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def include_to_pin decl, closure
+        type = generic_type(decl.name, decl.args)
+        generic_values = type.all_params.map(&:to_s)
         pins.push Solargraph::Pin::Reference::Include.new(
           name: decl.name.relative!.to_s,
+          generic_values: generic_values,
           closure: closure
         )
       end
 
+      # @param decl [RBS::AST::Members::Prepend]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def prepend_to_pin decl, closure
         pins.push Solargraph::Pin::Reference::Prepend.new(
           name: decl.name.relative!.to_s,
@@ -366,6 +510,9 @@ module Solargraph
         )
       end
 
+      # @param decl [RBS::AST::Members::Extend]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def extend_to_pin decl, closure
         pins.push Solargraph::Pin::Reference::Extend.new(
           name: decl.name.relative!.to_s,
@@ -374,6 +521,8 @@ module Solargraph
       end
 
       # @param decl [RBS::AST::Members::Alias]
+      # @param closure [Pin::Namespace]
+      # @return [void]
       def alias_to_pin decl, closure
         pins.push Solargraph::Pin::MethodAlias.new(
           name: decl.new_name.to_s,
@@ -390,7 +539,7 @@ module Solargraph
         'NilClass' => 'nil'
       }
 
-      # @param type [RBS::AST::Members::MethodDefinition::Overload]
+      # @param type [RBS::MethodType]
       # @return [String]
       def method_type_to_tag type
         if type_aliases.key?(type.type.return_type.to_s)
@@ -400,6 +549,25 @@ module Solargraph
         end
       end
 
+      # @param type_name [RBS::TypeName]
+      # @param type_args [Enumerable<RBS::Types::Bases::Base>]
+      # @return [ComplexType]
+      def generic_type(type_name, type_args)
+        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' }
+        params_str = params.empty? ? '' : "<#{params.join(', ')}>"
+        type_string = "#{base}#{params_str}"
+        ComplexType.parse(type_string)
+      end
+
+      # @param type_name [RBS::TypeName]
+      # @param type_args [Enumerable<RBS::Types::Bases::Base>]
+      # @return [String]
+      def generic_type_tag(type_name, type_args)
+        generic_type(type_name, type_args).tag
+      end
+
+      # @param type [RBS::Types::Bases::Base]
       # @return [String]
       def other_type_to_tag type
         if type.is_a?(RBS::Types::Optional)
@@ -427,14 +595,19 @@ module Solargraph
         elsif type.is_a?(RBS::Types::Variable)
           "#{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(', ')}>"
+          generic_type_tag(type.name, type.args)
         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::Bases::Top)
+          # top is the most super superclass
+          'BasicObject'
+        elsif type.is_a?(RBS::Types::Bases::Bottom)
+          # bottom is used in contexts where nothing will ever return
+          # - e.g., it could be the return type of 'exit()' or 'raise'
+          #
+          # @todo define a specific bottom type and use it to
+          #   determine dead code
+          'undefined'
         elsif type.is_a?(RBS::Types::Intersection)
           type.types.map { |member| other_type_to_tag(member) }.join(', ')
         elsif type.is_a?(RBS::Types::Proc)
@@ -446,6 +619,20 @@ module Solargraph
           'undefined'
         end
       end
+
+      # @param decl [RBS::AST::Declarations::Class, RBS::AST::Declarations::Module]
+      # @param closure [Pin::Closure]
+      # @return [void]
+      def add_mixins decl, closure
+        decl.each_mixin do |mixin|
+          klass = mixin.is_a?(RBS::AST::Members::Include) ? Pin::Reference::Include : Pin::Reference::Extend
+          pins.push klass.new(
+            name: mixin.name.relative!.to_s,
+            location: rbs_location_to_location(mixin.location),
+            closure: closure
+          )
+        end
+      end
     end
   end
 end

data/lib/solargraph/rbs_map/core_fills.rb

@@ -22,33 +22,11 @@ module Solargraph
                                     closure: Solargraph::Pin::Namespace.new(name: 'Object'), comments: '@return [Class<self>]')
       ]
 
-      YIELDPARAMS = [
-        Override.from_comment('Object#tap', %(
-@return [self]
-@yieldparam [self]
-        )),
-        Override.from_comment('String#each_line', %(
-@yieldparam [String]
-        ))
-      ]
-
-      methods_with_yieldparam_subtypes = %w[
-        Array#each Array#map Array#map! Array#any? Array#all? Array#index
-        Array#keep_if Array#delete_if
-        Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
-        Enumerable#select Enumerable#reject
-        Set#each
-      ]
-
-      YIELDPARAM_SINGLE_PARAMETERS = methods_with_yieldparam_subtypes.map do |path|
-        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
@@ -60,7 +38,7 @@ module Solargraph
       end
       ERRNOS = errnos
 
-      ALL = KEYWORDS + MISSING + YIELDPARAMS + YIELDPARAM_SINGLE_PARAMETERS + CLASS_RETURN_TYPES + ERRNOS
+      ALL = KEYWORDS + MISSING + CLASS_RETURN_TYPES + ERRNOS
     end
   end
 end

data/lib/solargraph/rbs_map/core_map.rb

@@ -28,6 +28,7 @@ module Solargraph
         return super unless stubs
         stubs.map do |stub|
           Pin::Signature.new(
+            [],
             [],
             ComplexType.try_parse(stub.return_type)
           )

data/lib/solargraph/rbs_map/core_signs.rb

@@ -8,6 +8,8 @@ module Solargraph
 
         attr_reader :return_type
 
+        # @param parameters [Array<Hash>]
+        # @param return_type [String]
         def initialize parameters, return_type
           @parameters = parameters
           @return_type = return_type

data/lib/solargraph/rbs_map/stdlib_map.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rbs'
-require 'set'
 
 module Solargraph
   class RbsMap
@@ -16,11 +15,10 @@ module Solargraph
         cache = Cache.load('stdlib', "#{library}.ser")
         if cache
           pins.replace cache
+          @resolved = true
         else
           super
-          if library == 'yaml'
-            pins.push Solargraph::Pin::Constant.new(name: 'YAML', comments: '@return [Module<Psych>]', closure: Pin::ROOT_PIN)
-          end
+          return unless resolved?
           Cache.save('stdlib', "#{library}.ser", pins)
         end
       end
@@ -30,10 +28,6 @@ module Solargraph
       def self.load library
         @stdlib_maps_hash[library] ||= StdlibMap.new(library)
       end
-
-      def repository
-        @repository ||= RBS::Repository.new
-      end
     end
   end
 end

data/lib/solargraph/rbs_map.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rbs'
-require 'set'
 
 module Solargraph
   class RbsMap
@@ -19,18 +18,24 @@ module Solargraph
     attr_reader :library
 
     # @param library [String]
-    def initialize library
+    def initialize library, version = nil
       @library = library
+      @version = version
+      @collection = nil
       loader = RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
-      add_library loader, library
+      add_library loader, library, version
       return unless resolved?
       load_environment_to_pins(loader)
     end
 
+    # @param path [String]
+    # @return [Pin::Base, nil]
     def path_pin path
       pins.find { |p| p.path == path }
     end
 
+    # @param path [String]
+    # @return [Array<Pin::Base>]
     def path_pins path
       pins.select { |p| p.path == path }
     end
@@ -39,14 +44,18 @@ module Solargraph
       @resolved
     end
 
+    def repository
+      @repository ||= RBS::Repository.new(no_stdlib: false)
+    end
+
     # @param library [String]
     # @return [RbsMap]
     def self.load library
       @@rbs_maps_hash[library] ||= RbsMap.new(library)
     end
 
-    def repository
-      @repository ||= RBS::Repository.new(no_stdlib: true)
+    def self.from_gemspec(gemspec)
+      RbsMap.new(gemspec.name, gemspec.version)
     end
 
     private
@@ -54,17 +63,18 @@ module Solargraph
     # @param loader [RBS::EnvironmentLoader]
     # @param library [String]
     # @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, version: nil
+    def add_library loader, library, version
+      @resolved = if loader.has_library?(library: library, version: version)
+        loader.add library: library, version: version
         Solargraph.logger.info "#{short_name} successfully loaded library #{library}"
         true
       else
-        Solargraph.logger.info "#{short_name} failed to load library #{library}"
+        Solargraph.logger.debug "#{short_name} failed to load library #{library}"
         false
       end
     end
 
+    # @return [String]
     def short_name
       self.class.name.split('::').last
     end