solargraph 0.48.0 → 0.49.0

data/lib/solargraph/rbs_map/conversions.rb

@@ -0,0 +1,394 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class RbsMap
+    # Functions for converting RBS declarations to Solargraph pins
+    #
+    module Conversions
+      # A container for tracking the current context of the RBS conversion
+      # process, e.g., what visibility is declared for methods in the current
+      # scope
+      #
+      class Context
+        attr_reader :visibility
+
+        # @param visibility [Symbol]
+        def initialize visibility = :public
+          @visibility = visibility
+        end
+      end
+
+      # @return [Array<Pin::Base>]
+      def pins
+        @pins ||= []
+      end
+
+      private
+
+      def type_aliases
+        @type_aliases ||= {}
+      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
+        when RBS::AST::Declarations::Interface
+          # STDERR.puts "Skipping interface #{decl.name.relative!}"
+          interface_decl_to_pin decl
+        when RBS::AST::Declarations::Alias
+          type_aliases[decl.name.to_s] = decl
+        when RBS::AST::Declarations::Module
+          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
+          )
+        end
+      end
+
+      def convert_members_to_pin decl, closure
+        context = Context.new
+        decl.members.each { |m| context = convert_member_to_pin(m, closure, context) }
+      end
+
+      def convert_member_to_pin member, closure, context
+        case member
+        when RBS::AST::Members::MethodDefinition
+          method_def_to_pin(member, closure)
+        when RBS::AST::Members::AttrReader
+          attr_reader_to_pin(member, closure)
+        when RBS::AST::Members::AttrWriter
+          attr_writer_to_pin(member, closure)
+        when RBS::AST::Members::AttrAccessor
+          attr_accessor_to_pin(member, closure)
+        when RBS::AST::Members::Include
+          include_to_pin(member, closure)
+        when RBS::AST::Members::Prepend
+          prepend_to_pin(member, closure)
+        when RBS::AST::Members::Extend
+          extend_to_pin(member, closure)
+        when RBS::AST::Members::Alias
+          alias_to_pin(member, closure)
+        when RBS::AST::Members::InstanceVariable
+          ivar_to_pin(member, closure)
+        when RBS::AST::Members::Public
+          return Context.new(visibility: :public)
+        when RBS::AST::Members::Private
+          return Context.new(visibility: :private)
+        when RBS::AST::Declarations::Base
+          convert_decl_to_pin(member, closure)
+        else
+          Solargraph.logger.warn "Skipping member #{member.class}"
+        end
+        context
+      end
+
+      # @param decl [RBS::AST::Declarations::Class]
+      # @return [void]
+      def class_decl_to_pin decl
+        class_pin = Solargraph::Pin::Namespace.new(
+          type: :class,
+          name: decl.name.relative!.to_s,
+          closure: Solargraph::Pin::ROOT_PIN,
+          comments: decl.comment&.string,
+          parameters: decl.type_params.map(&:name).map(&:to_s)
+        )
+        pins.push class_pin
+        if decl.super_class
+          pins.push Solargraph::Pin::Reference::Superclass.new(
+            closure: class_pin,
+            name: decl.super_class.name.relative!.to_s
+          )
+        end
+        convert_members_to_pin decl, class_pin
+      end
+
+      # @param decl [RBS::AST::Declarations::Interface]
+      # @return [void]
+      def interface_decl_to_pin decl
+        class_pin = Solargraph::Pin::Namespace.new(
+          type: :module,
+          name: decl.name.relative!.to_s,
+          closure: Solargraph::Pin::ROOT_PIN,
+          comments: decl.comment&.string,
+          # 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
+      end
+
+      # @param decl [RBS::AST::Declarations::Module]
+      # @return [void]
+      def module_decl_to_pin decl
+        module_pin = Solargraph::Pin::Namespace.new(
+          type: :module,
+          name: decl.name.relative!.to_s,
+          closure: Solargraph::Pin::ROOT_PIN,
+          comments: decl.comment&.string
+        )
+        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('::')
+        if parts.length > 1
+          name = parts.last
+          closure = pins.select { |pin| pin && pin.path == parts[0..-2].join('::') }.first
+        else
+          name = parts.first
+          closure = Solargraph::Pin::ROOT_PIN
+        end
+        pin = Solargraph::Pin::Constant.new(
+          name: name,
+          closure: closure,
+          comments: decl.comment&.string
+        )
+        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
+      end
+
+      # @param decl [RBS::AST::Members::MethodDefinition]
+      # @param closure [Pin::Closure]
+      # @return [void]
+      def method_def_to_pin decl, closure
+        if decl.instance?
+          pin = Solargraph::Pin::Method.new(
+            name: decl.name.to_s,
+            closure: closure,
+            comments: decl.comment&.string,
+            scope: :instance,
+            signatures: []
+          )
+          pin.signatures.concat method_def_to_sigs(decl, pin)
+          pins.push pin
+          if pin.name == 'initialize'
+            pins.push Solargraph::Pin::Method.new(
+              location: pin.location,
+              closure: pin.closure,
+              name: 'new',
+              comments: pin.comments,
+              scope: :class,
+              signatures: pin.signatures
+            )
+            pins.last.signatures.replace(
+              pin.signatures.map do |p|
+                Pin::Signature.new(
+                  p.parameters,
+                  ComplexType::SELF
+                )
+              end
+            )
+            # @todo Is this necessary?
+            # pin.instance_variable_set(:@visibility, :private)
+            # pin.instance_variable_set(:@return_type, ComplexType::VOID)
+          end
+        end
+        if decl.singleton?
+          pin = Solargraph::Pin::Method.new(
+            name: decl.name.to_s,
+            closure: closure,
+            comments: decl.comment&.string,
+            scope: :class,
+            signatures: []
+          )
+          pin.signatures.concat method_def_to_sigs(decl, pin)
+          pins.push pin
+        end
+      end
+
+      # @param decl [RBS::AST::Members::MethodDefinition]
+      # @param pin [Pin::Method]
+      def method_def_to_sigs decl, pin
+        decl.types.map do |type|
+          parameters, return_type = parts_of_function(type, pin)
+          block = if type.block
+            Pin::Signature.new(*parts_of_function(type.block, pin))
+          end
+          return_type = ComplexType.try_parse(method_type_to_tag(type))
+          Pin::Signature.new(parameters, return_type, block)
+        end
+      end
+
+      def parts_of_function type, pin
+        parameters = []
+        arg_num = -1
+        type.type.required_positionals.each do |param|
+          name = param.name ? param.name.to_s : "arg#{arg_num += 1}"
+          parameters.push Solargraph::Pin::Parameter.new(decl: :arg, name: name, closure: pin, return_type: ComplexType.try_parse(other_type_to_tag(param.type)))
+        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)
+        end
+        if type.type.rest_positionals
+          name = type.type.rest_positionals.name ? type.type.rest_positionals.name.to_s : "arg#{arg_num += 1}"
+          parameters.push Solargraph::Pin::Parameter.new(decl: :restarg, name: name, closure: pin)
+        end
+        type.type.trailing_positionals.each do |param|
+          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|
+          name = orig ? orig.to_s : "arg#{arg_num += 1}"
+          parameters.push Solargraph::Pin::Parameter.new(decl: :kwarg, name: name, closure: pin)
+        end
+        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)
+        end
+        if type.type.rest_keywords
+          name = type.type.rest_keywords.name ? type.type.rest_keywords.name.to_s : "arg#{arg_num += 1}"
+          parameters.push Solargraph::Pin::Parameter.new(decl: :kwrestarg, name: type.type.rest_keywords.name.to_s, closure: pin)
+        end
+        return_type = ComplexType.try_parse(method_type_to_tag(type))
+        [parameters, return_type]
+      end
+
+      def attr_reader_to_pin(decl, closure)
+        pin = Solargraph::Pin::Method.new(
+          name: decl.name.to_s,
+          closure: closure,
+          comments: decl.comment&.string,
+          scope: :instance,
+          attribute: true
+        )
+        pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', other_type_to_tag(decl.type)))
+        pins.push pin
+      end
+
+      def attr_writer_to_pin(decl, closure)
+        pin = Solargraph::Pin::Method.new(
+          name: "#{decl.name.to_s}=",
+          closure: closure,
+          comments: decl.comment&.string,
+          scope: :instance,
+          attribute: true
+        )
+        pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', other_type_to_tag(decl.type)))
+        pins.push pin
+      end
+
+      def attr_accessor_to_pin(decl, closure)
+        attr_reader_to_pin(decl, closure)
+        attr_writer_to_pin(decl, closure)
+      end
+
+      def ivar_to_pin(decl, closure)
+        pin = Solargraph::Pin::InstanceVariable.new(
+          name: decl.name.to_s,
+          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
+
+      def include_to_pin decl, closure
+        pins.push Solargraph::Pin::Reference::Include.new(
+          name: decl.name.relative!.to_s,
+          closure: closure
+        )
+      end
+
+      def prepend_to_pin decl, closure
+        pins.push Solargraph::Pin::Reference::Prepend.new(
+          name: decl.name.relative!.to_s,
+          closure: closure
+        )
+      end
+
+      def extend_to_pin decl, closure
+        pins.push Solargraph::Pin::Reference::Extend.new(
+          name: decl.name.relative!.to_s,
+          closure: closure
+        )
+      end
+
+      def alias_to_pin decl, closure
+        pins.push Solargraph::Pin::MethodAlias.new(
+          name: decl.new_name.to_s,
+          original: decl.old_name.to_s,
+          closure: closure
+        )
+      end
+
+      RBS_TO_YARD_TYPE = {
+        'bool' => 'Boolean',
+        'string' => 'String',
+        'int' => 'Integer',
+        'untyped' => '',
+        'NilClass' => 'nil'
+      }
+
+      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)
+        else
+          other_type_to_tag type.type.return_type
+        end
+      end
+
+      # @return [String]
+      def other_type_to_tag type
+        if type.is_a?(RBS::Types::Optional)
+          "#{other_type_to_tag(type.type)}, nil"
+        elsif type.is_a?(RBS::Types::Bases::Any)
+          # @todo Not sure what to do with Any yet
+          'BasicObject'
+        elsif type.is_a?(RBS::Types::Bases::Bool)
+          'Boolean'
+        elsif type.is_a?(RBS::Types::Tuple)
+          "Array(#{type.types.map { |t| other_type_to_tag(t) }.join(', ')})"
+        elsif type.is_a?(RBS::Types::Literal)
+          "#{type.literal}"
+        elsif type.is_a?(RBS::Types::Union)
+          type.types.map { |t| other_type_to_tag(t) }.join(', ')
+        elsif type.is_a?(RBS::Types::Record)
+          # @todo Better record support
+          'Hash'
+        elsif type.is_a?(RBS::Types::Bases::Nil)
+          'nil'
+        elsif type.is_a?(RBS::Types::Bases::Self)
+          'self'
+        elsif type.is_a?(RBS::Types::Bases::Void)
+          'void'
+        elsif type.is_a?(RBS::Types::Variable)
+          "param<#{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.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}"
+          'undefined'
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/rbs_map/core_fills.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class RbsMap
+    # Override pins to fill gaps in RbsMap::CoreMap coverage
+    #
+    module CoreFills
+      Override = Pin::Reference::Override
+
+      KEYWORDS = [
+        '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
+        'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
+        'elsif', 'end', 'ensure', 'false', 'for', 'if', 'in', 'module', 'next',
+        'nil', 'not', 'or', 'redo', 'rescue', 'retry', 'return', 'self', 'super',
+        'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
+      ].map { |k| Pin::Keyword.new(k) }
+
+      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, %(
+@yieldparam_single_parameter
+          ))
+      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
+      errno = Solargraph::Pin::Namespace.new(name: 'Errno')
+      errnos = []
+      Errno.constants.each do |const|
+        errnos.push Solargraph::Pin::Namespace.new(type: :class, name: const.to_s, closure: errno)
+        errnos.push Solargraph::Pin::Reference::Superclass.new(closure: errnos.last, name: 'SystemCallError')
+      end
+      ERRNOS = errnos
+
+      ALL = KEYWORDS + YIELDPARAMS + YIELDPARAM_SINGLE_PARAMETERS + CLASS_RETURN_TYPES + ERRNOS
+    end
+  end
+end

data/lib/solargraph/rbs_map/core_map.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class RbsMap
+    # Ruby core pins
+    #
+    class CoreMap
+      include Conversions
+
+      def initialize
+        cache = Cache.load('core.ser')
+        if cache
+          pins.replace cache
+        else
+          loader = RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: true))
+          environment = RBS::Environment.from_loader(loader).resolve_type_names
+          environment.declarations.each { |decl| convert_decl_to_pin(decl, Solargraph::Pin::ROOT_PIN) }
+          pins.concat RbsMap::CoreFills::ALL
+          processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
+          pins.replace processed
+
+          Cache.save('core.ser', pins)
+        end
+      end
+
+      def method_def_to_sigs decl, pin
+        stubs = CoreSigns.sign(pin.path)
+        return super unless stubs
+        stubs.map do |stub|
+          Pin::Signature.new(
+            [],
+            ComplexType.try_parse(stub.return_type)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/rbs_map/core_signs.rb

@@ -0,0 +1,33 @@
+module Solargraph
+  class RbsMap
+    module CoreSigns
+      Override = Pin::Reference::Override
+
+      class Stub
+        attr_reader :parameters
+
+        attr_reader :return_type
+
+        def initialize parameters, return_type
+          @parameters = parameters
+          @return_type = return_type
+        end
+      end
+
+      SIGNATURE_MAP = {
+        'Object#class' => [
+          Stub.new(
+            [],
+            'Class<self>'
+          )
+        ]
+      }
+
+      # @param path [String]
+      # @return [Array<Stub>]
+      def self.sign path
+        SIGNATURE_MAP[path]
+      end
+    end
+  end
+end

data/lib/solargraph/rbs_map/stdlib_map.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rbs'
+require 'set'
+
+module Solargraph
+  class RbsMap
+    # Ruby stdlib pins
+    #
+    class StdlibMap < RbsMap
+      # @type [Hash{String => RbsMap}]
+      @stdlib_maps_hash = {}
+
+      # @param library [String]
+      def initialize library
+        cache = Cache.load('stdlib', "#{library}.ser")
+        if cache
+          pins.replace cache
+        else
+          super
+          Cache.save('stdlib', "#{library}.ser", pins)
+        end
+      end
+
+      # @param library [String]
+      # @return [StdlibMap]
+      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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'rbs'
+require 'set'
+
+module Solargraph
+  class RbsMap
+    autoload :Conversions, 'solargraph/rbs_map/conversions'
+    autoload :CoreMap,     'solargraph/rbs_map/core_map'
+    autoload :CoreFills,   'solargraph/rbs_map/core_fills'
+    autoload :CoreSigns,   'solargraph/rbs_map/core_signs'
+    autoload :StdlibMap,   'solargraph/rbs_map/stdlib_map'
+
+    include Conversions
+
+    # @type [Hash{String => RbsMap}]
+    @@rbs_maps_hash = {}
+
+    attr_reader :library
+
+    # @param library [String]
+    def initialize library
+      @library = library
+      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) }
+    end
+
+    def path_pin path
+      pins.find { |p| p.path == path }
+    end
+
+    def path_pins path
+      pins.select { |p| p.path == path }
+    end
+
+    def resolved?
+      @resolved
+    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)
+    end
+
+    private
+
+    # @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
+        Solargraph.logger.info "#{short_name} successfully loaded library #{library}"
+        true
+      else
+        Solargraph.logger.info "#{short_name} failed to load library #{library}"
+        false
+      end
+    end
+
+    def short_name
+      self.class.name.split('::').last
+    end
+  end
+end