solargraph 0.47.2 → 0.50.0

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

data/lib/solargraph/shell.rb

@@ -71,43 +71,46 @@ module Solargraph
       STDOUT.puts "Configuration file initialized."
     end
 
-    desc 'download-core [VERSION]', 'Download core documentation'
-    def download_core version = nil
-      ver = version || Solargraph::YardMap::CoreDocs.best_download
-      if RUBY_VERSION != ver
-        puts "Documentation for #{RUBY_VERSION} is not available. Reverting to closest match..."
-      end
-      puts "Downloading docs for #{ver}..."
-      Solargraph::YardMap::CoreDocs.download ver
-      # Clear cached documentation if it exists
-      FileUtils.rm_rf Dir.glob(File.join(Solargraph::YardMap::CoreDocs.cache_dir, ver, '*.ser'))
-      puts "Download complete."
-    rescue ArgumentError => e
-      STDERR.puts "ERROR: #{e.message}"
-      STDERR.puts "Run `solargraph available-cores` for a list."
-      exit 1
-    end
-
-    desc 'list-cores', 'List the local documentation versions'
+    desc 'download-core [VERSION]', 'Download core documentation [deprecated]', hide: true
+    long_desc %(
+      The `download-core` command is deprecated. Current versions of Solargraph
+      use RBS for core and stdlib documentation.
+    )
+    # @deprecated
+    def download_core _version = nil
+      puts 'The `download-core` command is deprecated.'
+      puts 'Current versions of Solargraph use RBS for core and stdlib documentation.'
+    end
+
+    desc 'list-cores', 'List the local documentation versions [deprecated]', hide: true
+    long_desc %(
+      The `list-cores` command is deprecated. Current versions of Solargraph use
+      RBS for core and stdlib documentation.
+    )
+    # @deprecated
     def list_cores
-      puts Solargraph::YardMap::CoreDocs.versions.join("\n")
+      puts 'The `list-cores` command is deprecated.'
+      puts 'Current versions of Solargraph use RBS for core and stdlib documentation.'
     end
 
-    desc 'available-cores', 'List available documentation versions'
+    desc 'available-cores', 'List available documentation versions [deprecated]', hide: true
+    long_desc %(
+      The `available-cores` command is deprecated. Current versions of Solargraph
+      use RBS for core and stdlib documentation.
+    )
+    # @deprecated
     def available_cores
-      puts Solargraph::YardMap::CoreDocs.available.join("\n")
+      puts 'The `available-cores` command is deprecated.'
+      puts 'Current versions of Solargraph use RBS for core and stdlib documentation.'
     end
 
     desc 'clear', 'Delete all cached documentation'
     long_desc %(
       This command will delete all core and gem documentation from the cache.
-      You can also delete specific gem caches with the `uncache` command or
-      update documentation for specific Ruby versions with the `download-core`
-      command.
     )
     def clear
       puts "Deleting the cached documentation"
-      Solargraph::YardMap::CoreDocs.clear
+      Solargraph::Cache.clear
     end
     map 'clear-cache' => :clear
     map 'clear-cores' => :clear
@@ -191,18 +194,33 @@ module Solargraph
       puts "Scanned #{directory} (#{api_map.pins.length} pins) in #{time.real} seconds."
     end
 
-    desc 'bundle', 'Generate documentation for bundled gems'
+    desc 'list', 'List the files in the workspace and the total count'
+    option :count, type: :boolean, aliases: :c, desc: 'Display the file count only', default: false
+    option :directory, type: :string, aliases: :d, desc: 'The directory to read', default: '.'
+    def list
+      workspace = Solargraph::Workspace.new(options[:directory])
+      unless options[:count]
+        workspace.filenames.each { |f| puts f }
+      end
+      puts "#{workspace.filenames.length} files total."
+    end
+
+    desc 'bundle', 'Generate documentation for bundled gems [deprecated]', hide: true
+    long_desc %(
+      The `bundle` command is deprecated. Solargraph currently uses RBS instead.
+    )
     option :directory, type: :string, aliases: :d, desc: 'The workspace directory', default: '.'
     option :rebuild, type: :boolean, aliases: :r, desc: 'Rebuild existing documentation', default: false
     def bundle
-      Documentor.new(options[:directory], rebuild: options[:rebuild], out: STDOUT).document
+      puts 'The `bundle` command is deprecated. Solargraph currently uses RBS instead.'
     end
 
-    desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation'
-    def rdoc gem, version = '>= 0'
-      spec = Gem::Specification.find_by_name(gem, version)
-      puts "Caching #{spec.name} #{spec.version} from RDoc"
-      Solargraph::YardMap::RdocToYard.run(spec)
+    desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation [deprecated]', hide: true
+    long_desc %(
+      The `rdoc` command is deprecated. Solargraph currently uses RBS instead.
+    )
+    def rdoc _gem, _version = '>= 0'
+      puts 'The `rdoc` command is deprecated. Solargraph currently uses RBS instead.'
     end
 
     private

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

@@ -35,7 +35,10 @@ module Solargraph
             []
           end
           return inferred_pins(found, api_map, name_pin.context, locals) unless found.empty?
-          pins = api_map.get_method_stack(name_pin.binder.namespace, word, scope: name_pin.binder.scope)
+          # @param [ComplexType::UniqueType]
+          pins = name_pin.binder.each_unique_type.flat_map do |context|
+            api_map.get_method_stack(context.namespace, word, scope: context.scope)
+          end
           return [] if pins.empty?
           inferred_pins(pins, api_map, name_pin.context, locals)
         end
@@ -49,36 +52,32 @@ module Solargraph
         # @return [Array<Pin::Base>]
         def inferred_pins pins, api_map, context, locals
           result = pins.map do |p|
-            overloads = p.docstring.tags(:overload)
+            next p unless p.is_a?(Pin::Method)
+            overloads = p.signatures
             # next p if overloads.empty?
             type = ComplexType::UNDEFINED
-            # @param [YARD::Tags::OverloadTag]
             overloads.each do |ol|
-              next unless arguments_match(arguments, ol.parameters)
-              next if ol.parameters.last && ol.parameters.last.first.start_with?('&') && ol.parameters.last.last.nil? && !with_block?
+              next unless arguments_match(arguments, ol)
+              # next if ol.parameters.last && ol.parameters.last.first.start_with?('&') && ol.parameters.last.last.nil? && !with_block?
               match = true
               arguments.each_with_index do |arg, idx|
-                achain = arguments[idx]
-                next if achain.nil?
                 param = ol.parameters[idx]
                 if param.nil?
-                  match = false unless ol.parameters.last && ol.parameters.last.first.start_with?('*')
+                  match = false unless ol.parameters.any?(&:restarg?)
                   break
                 end
-                par = ol.tags(:param).select { |pp| pp.name == param.first }.first
-                next if par.nil? || par.types.nil? || par.types.empty?
-                atype = achain.infer(api_map, Pin::ProxyType.anonymous(context), locals)
-                other = ComplexType.try_parse(*par.types)
+                atype = arg.infer(api_map, Pin::ProxyType.anonymous(context), locals)
                 # @todo Weak type comparison
-                unless atype.tag == other.tag || api_map.super_and_sub?(other.tag, atype.tag)
+                # unless atype.tag == param.return_type.tag || api_map.super_and_sub?(param.return_type.tag, atype.tag)
+                unless param.return_type.undefined? || atype.name == param.return_type.name || api_map.super_and_sub?(param.return_type.name, atype.name)
                   match = false
                   break
                 end
               end
               if match
-                type = extra_return_type(ol, context)
+                type = extra_return_type(p.docstring, context)
                 break if type
-                type = ComplexType.try_parse(*ol.tag(:return).types).self_to(context.to_s).qualify(api_map, context.namespace) if ol.has_tag?(:return) && ol.tag(:return).types && !ol.tag(:return).types.empty? && (type.nil? || type.undefined?)
+                type = with_params(ol.return_type.self_to(context.to_s), context).qualify(api_map, context.namespace) if ol.return_type.defined?
                 type ||= ComplexType::UNDEFINED
               end
               break if type.defined?
@@ -107,9 +106,13 @@ module Solargraph
             p
           end
           result.map do |pin|
-            next pin if pin.return_type.undefined?
-            selfy = pin.return_type.self_to(context.tag)
-            selfy == pin.return_type ? pin : pin.proxy(selfy)
+            if pin.path == 'Class#new' && context.tag != 'Class'
+              pin.proxy(ComplexType.try_parse(context.namespace))
+            else
+              next pin if pin.return_type.undefined?
+              selfy = pin.return_type.self_to(context.tag)
+              selfy == pin.return_type ? pin : pin.proxy(selfy)
+            end
           end
         end
 
@@ -180,14 +183,15 @@ module Solargraph
         end
 
         # @param arguments [Array<Chain>]
-        # @param parameters [Array<String>]
+        # @param signature [Pin::Signature]
         # @return [Boolean]
-        def arguments_match arguments, parameters
+        def arguments_match arguments, signature
+          parameters = signature.parameters
           argcount = arguments.length
-          # argcount -= 1 if !arguments.empty? && arguments.last.links.first.word.start_with?('&')
           parcount = parameters.length
-          parcount -= 1 if !parameters.empty? && parameters.last.first.start_with?('&')
-          return false if argcount < parcount && !(argcount == parcount - 1 && parameters.last.first.start_with?('*'))
+          parcount -= 1 if !parameters.empty? && parameters.last.block?
+          return false if signature.block? && !with_block?
+          return false if argcount < parcount && !(argcount == parcount - 1 && parameters.last.restarg?)
           true
         end
 
@@ -195,9 +199,16 @@ module Solargraph
         # @param name_pin [Pin::Base]
         # @return [Array<Pin::Base>]
         def super_pins api_map, name_pin
-          pins = api_map.get_method_stack(name_pin.namespace, name_pin.name, scope: name_pin.scope)
+          pins = api_map.get_method_stack(name_pin.namespace, name_pin.name, scope: name_pin.context.scope)
           pins.reject{|p| p.path == name_pin.path}
         end
+
+        # @param type [ComplexType]
+        # @param context [ComplexType]
+        def with_params type, context
+          return type unless type.to_s.include?('$')
+          ComplexType.try_parse(type.to_s.gsub('$', context.value_types.map(&:tag).join(', ')).gsub('<>', ''))
+        end
       end
     end
   end

data/lib/solargraph/source/chain.rb

@@ -63,11 +63,11 @@ module Solargraph
         working_pin = name_pin
         links[0..-2].each do |link|
           pins = link.resolve(api_map, working_pin, locals)
-          type = infer_first_defined(pins, working_pin, api_map)
+          type = infer_first_defined(pins, working_pin, api_map, locals)
           return [] if type.undefined?
           working_pin = Pin::ProxyType.anonymous(type)
         end
-        links.last.last_context = working_pin
+        links.last.last_context = name_pin
         links.last.resolve(api_map, working_pin, locals)
       end
 
@@ -76,8 +76,12 @@ module Solargraph
       # @param locals [Array<Pin::Base>]
       # @return [ComplexType]
       def infer api_map, name_pin, locals
+        from_here = base.infer(api_map, name_pin, locals) unless links.length == 1
+        if from_here
+          name_pin = name_pin.proxy(from_here)
+        end
         pins = define(api_map, name_pin, locals)
-        type = infer_first_defined(pins, links.last.last_context, api_map)
+        type = infer_first_defined(pins, links.last.last_context, api_map, locals)
         maybe_nil(type)
       end
 
@@ -110,9 +114,10 @@ module Solargraph
       private
 
       # @param pins [Array<Pin::Base>]
+      # @param context [Pin::Base]
       # @param api_map [ApiMap]
       # @return [ComplexType]
-      def infer_first_defined pins, context, api_map
+      def infer_first_defined pins, context, api_map, locals
         possibles = []
         pins.each do |pin|
           # Avoid infinite recursion
@@ -121,8 +126,18 @@ module Solargraph
           type = pin.typify(api_map)
           @@inference_stack.pop
           if type.defined?
-            possibles.push type
-            break if pin.is_a?(Pin::Method)
+            if type.parameterized?
+              type = type.resolve_parameters(pin.closure, context)
+              # idx = pin.closure.parameters.index(type.subtypes.first.name)
+              # next if idx.nil?
+              # param_type = context.return_type.all_params[idx]
+              # next unless param_type
+              # type = ComplexType.try_parse(param_type.to_s)
+            end
+            if type.defined?
+              possibles.push type
+              break if pin.is_a?(Pin::Method)
+            end
           end
         end
         if possibles.empty?
@@ -147,7 +162,7 @@ module Solargraph
           sorted = possibles.map { |t| t.rooted? ? "::#{t}" : t.to_s }.sort { |a, _| a == 'nil' ? 1 : 0 }
           ComplexType.parse(*sorted)
         else
-          possibles.first
+          ComplexType.parse(possibles.map(&:to_s).join(', '))
         end
         return type if context.nil? || context.return_type.undefined?
         type.self_to(context.return_type.namespace)

data/lib/solargraph/source_map/clip.rb

@@ -43,6 +43,11 @@ module Solargraph
       # @return [ComplexType]
       def infer
         result = cursor.chain.infer(api_map, block, locals)
+        if result.tag == 'Class'
+          # HACK: Exception to return Object from Class#new
+          dfn = cursor.chain.define(api_map, block, locals).first
+          return ComplexType.try_parse('Object') if dfn && dfn.path == 'Class#new'
+        end
         return result unless result.tag == 'self'
         ComplexType.try_parse(cursor.chain.base.infer(api_map, block, locals).namespace)
       end

data/lib/solargraph/source_map/mapper.rb

@@ -12,7 +12,7 @@ module Solargraph
 
       private_class_method :new
 
-      MACRO_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
+      DIRECTIVE_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
 
       # Generate the data.
       #
@@ -24,6 +24,8 @@ module Solargraph
         @code = source.code
         @comments = source.comments
         @pins, @locals = Parser.map(source)
+        @pins.each { |p| p.source = :code }
+        @locals.each { |l| l.source = :code }
         process_comment_directives
         [@pins, @locals]
       # rescue Exception => e
@@ -63,7 +65,7 @@ module Solargraph
       end
 
       def process_comment source_position, comment_position, comment
-        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ DIRECTIVE_REGEXP
         cmnt = remove_inline_comment_hashes(comment)
         parse = Solargraph::Source.parse_docstring(cmnt)
         last_line = 0
@@ -196,6 +198,8 @@ module Solargraph
           namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
         when 'override'
           pins.push Pin::Reference::Override.new(location, directive.tag.name, docstring.tags)
+        when 'macro'
+          # @todo Handle macros
         end
       end
 
@@ -209,7 +213,7 @@ module Solargraph
         started = false
         comment.lines.each { |l|
           # Trim the comment and minimum leading whitespace
-          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#/, '')
+          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
           if num.nil? && !p.strip.empty?
             num = p.index(/[^ ]/)
             started = true
@@ -224,7 +228,7 @@ module Solargraph
 
       # @return [void]
       def process_comment_directives
-        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
+        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ DIRECTIVE_REGEXP
         code_lines = @code.lines
         @source.associated_comments.each do |line, comments|
           src_pos = line ? Position.new(line, code_lines[line].to_s.chomp.index(/[^\s]/) || 0) : Position.new(code_lines.length, 0)