solargraph 0.51.2 → 0.54.2

data/lib/solargraph/rbs_map/core_fills.rb

@@ -16,39 +16,23 @@ 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 = [
-        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>'),
+      OVERRIDES = [
+        Override.from_comment('BasicObject#instance_eval', '@yieldreceiver [self]'),
+        Override.from_comment('BasicObject#instance_exec', '@yieldreceiver [self]'),
+        Override.from_comment('Module#define_method', '@yieldreceiver [::Object<self>]'),
+        Override.from_comment('Module#class_eval', '@yieldreceiver [::Class<self>]'),
+        Override.from_comment('Module#class_exec', '@yieldreceiver [::Class<self>]'),
+        Override.from_comment('Module#module_eval', '@yieldreceiver [::Module<self>]'),
+        Override.from_comment('Module#module_exec', '@yieldreceiver [::Module<self>]'),
+        # RBS does not define Class with a generic, so all calls to
+        # generic() return an 'untyped'.  We can do better:
+        Override.method_return('Class#allocate', 'self')
       ]
 
       # HACK: Add Errno exception classes
@@ -60,8 +44,7 @@ module Solargraph
       end
       ERRNOS = errnos
 
-      ALL = KEYWORDS + MISSING + YIELDPARAMS + YIELDPARAM_SINGLE_PARAMETERS + CLASS_RETURN_TYPES + ERRNOS
+      ALL = KEYWORDS + MISSING + OVERRIDES + ERRNOS
     end
   end
 end
-

data/lib/solargraph/rbs_map/core_map.rb

@@ -13,26 +13,16 @@ module Solargraph
           pins.replace cache
         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) }
+          RBS::Environment.from_loader(loader).resolve_type_names
+          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) }
+          processed.each { |pin| pin.source = :rbs }
           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/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,14 +1,13 @@
 # frozen_string_literal: true
 
+require 'pathname'
 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
@@ -19,19 +18,30 @@ module Solargraph
     attr_reader :library
 
     # @param library [String]
-    def initialize library
+    # @param version [String, nil]
+    # @param directories [Array<Pathname, String>]
+    def initialize library, version = nil, directories: []
       @library = library
+      @version = version
+      @collection = nil
+      @directories = directories
       loader = RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
-      add_library loader, library
+      add_library loader, library, version
       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
-      pins.find { |p| p.path == path }
+    # @generic T
+    # @param path [String]
+    # @param klass [Class<generic<T>>]
+    # @return [generic<T>, nil]
+    def path_pin path, klass = Pin::Base
+      pin = pins.find { |p| p.path == path }
+      pin if pin&.is_a?(klass)
     end
 
+    # @param path [String]
+    # @return [Array<Pin::Base>]
     def path_pins path
       pins.select { |p| p.path == path }
     end
@@ -40,14 +50,22 @@ module Solargraph
       @resolved
     end
 
+    def repository
+      @repository ||= RBS::Repository.new(no_stdlib: false).tap do |repo|
+        # @todo Temporarily ignoring external directories due to issues with
+        #   incomplete/broken gem_rbs_collection installations
+        # @directories.each { |dir| repo.add(Pathname.new(dir)) }
+      end
+    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
@@ -55,9 +73,9 @@ 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
+    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
@@ -66,6 +84,7 @@ module Solargraph
       end
     end
 
+    # @return [String]
     def short_name
       self.class.name.split('::').last
     end

data/lib/solargraph/shell.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
+require 'benchmark'
 require 'thor'
+require 'yard'
 
 module Solargraph
   class Shell < Thor
     include Solargraph::ServerMethods
 
+    # Tell Thor to ensure the process exits with status 1 if any error happens.
+    def self.exit_on_failure?
+      true
+    end
+
     map %w[--version -v] => :version
 
     desc "--version, -v", "Print the version"
+    # @return [void]
     def version
       puts Solargraph::VERSION
     end
@@ -16,6 +24,7 @@ module Solargraph
     desc 'socket', 'Run a Solargraph socket server'
     option :host, type: :string, aliases: :h, desc: 'The server host', default: '127.0.0.1'
     option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7658
+    # @return [void]
     def socket
       require 'backport'
       port = options[:port]
@@ -33,6 +42,7 @@ module Solargraph
     end
 
     desc 'stdio', 'Run a Solargraph stdio server'
+    # @return [void]
     def stdio
       require 'backport'
       Backport.run do
@@ -49,6 +59,8 @@ module Solargraph
 
     desc 'config [DIRECTORY]', 'Create or overwrite a default configuration file'
     option :extensions, type: :boolean, aliases: :e, desc: 'Add installed extensions', default: true
+    # @param directory [String]
+    # @return [void]
     def config(directory = '.')
       matches = []
       if options[:extensions]
@@ -71,62 +83,72 @@ module Solargraph
       STDOUT.puts "Configuration file initialized."
     end
 
-    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 '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 [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 '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.
     )
+    # @return [void]
     def clear
-      puts "Deleting the cached documentation"
+      puts "Deleting all cached documentation (gems, core and stdlib)"
       Solargraph::Cache.clear
     end
     map 'clear-cache' => :clear
     map 'clear-cores' => :clear
 
-    desc 'uncache GEM [...GEM]', "Delete cached gem documentation"
+    desc 'cache', 'Cache a gem', hide: true
+    # @return [void]
+    # @param gem [String]
+    # @param version [String, nil]
+    def cache gem, version = nil
+      spec = Gem::Specification.find_by_name(gem, version)
+      pins = GemPins.build(spec)
+      Cache.save('gems', "#{spec.name}-#{spec.version}.ser", pins)
+    end
+
+    desc 'uncache GEM [...GEM]', "Delete specific cached gem documentation"
+    long_desc %(
+      Specify one or more gem names to clear. 'core' or 'stdlib' may
+      also be specified to clear cached system documentation.
+      Documentation will be regenerated as needed.
+    )
+    # @return [void]
     def uncache *gems
       raise ArgumentError, 'No gems specified.' if gems.empty?
       gems.each do |gem|
-        Dir[File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{gem}-*")].each do |dir|
-          puts "Deleting cache: #{dir}"
-          FileUtils.remove_entry_secure dir
+        if gem == 'core'
+          Cache.uncache("core.ser")
+          next
+        end
+
+        if gem == 'stdlib'
+          Cache.uncache("stdlib")
+          next
+        end
+
+        spec = Gem::Specification.find_by_name(gem)
+        Cache.uncache('gems', "#{spec.name}-#{spec.version}.ser")
+        Cache.uncache('gems', "#{spec.name}-#{spec.version}.yardoc")
+      end
+    end
+
+    desc 'gems [GEM[=VERSION]]', 'Cache documentation for installed gems'
+    option :rebuild, type: :boolean, desc: 'Rebuild existing documentation', default: false
+    # @return [void]
+    def gems *names
+      if names.empty?
+        Gem::Specification.to_a.each { |spec| do_cache spec }
+      else
+        names.each do |name|
+          spec = Gem::Specification.find_by_name(*name.split('='))
+          do_cache spec
+        rescue Gem::MissingSpecError
+          warn "Gem '#{name}' not found"
         end
       end
     end
 
     desc 'reporters', 'Get a list of diagnostics reporters'
+    # @return [void]
     def reporters
       puts Solargraph::Diagnostics.reporters
     end
@@ -140,26 +162,33 @@ module Solargraph
     )
     option :level, type: :string, aliases: [:mode, :m, :l], desc: 'Type checking level', default: 'normal'
     option :directory, type: :string, aliases: :d, desc: 'The workspace directory', default: '.'
+    # @return [void]
     def typecheck *files
       directory = File.realpath(options[:directory])
-      api_map = Solargraph::ApiMap.load(directory)
+      api_map = Solargraph::ApiMap.load_with_cache(directory, $stdout)
+      probcount = 0
       if files.empty?
         files = api_map.source_maps.map(&:filename)
       else
         files.map! { |file| File.realpath(file) }
       end
-      probcount = 0
       filecount = 0
-      files.each do |file|
-        checker = TypeChecker.new(file, api_map: api_map, level: options[:level].to_sym)
-        problems = checker.problems
-        next if problems.empty?
-        problems.sort! { |a, b| a.location.range.start.line <=> b.location.range.start.line }
-        puts problems.map { |prob| "#{prob.location.filename}:#{prob.location.range.start.line + 1} - #{prob.message}" }.join("\n")
-        filecount += 1
-        probcount += problems.length
-      end
+
+      time = Benchmark.measure {
+        files.each do |file|
+          checker = TypeChecker.new(file, api_map: api_map, level: options[:level].to_sym)
+          problems = checker.problems
+          next if problems.empty?
+          problems.sort! { |a, b| a.location.range.start.line <=> b.location.range.start.line }
+          puts problems.map { |prob| "#{prob.location.filename}:#{prob.location.range.start.line + 1} - #{prob.message}" }.join("\n")
+          filecount += 1
+          probcount += problems.length
+        end
+        # "
+      }
+      puts "Typecheck finished in #{time.real} seconds."
       puts "#{probcount} problem#{probcount != 1 ? 's' : ''} found#{files.length != 1 ? " in #{filecount} of #{files.length} files" : ''}."
+      # "
       exit 1 if probcount > 0
     end
 
@@ -172,12 +201,12 @@ module Solargraph
     )
     option :directory, type: :string, aliases: :d, desc: 'The workspace directory', default: '.'
     option :verbose, type: :boolean, aliases: :v, desc: 'Verbose output', default: false
+    # @return [void]
     def scan
-      require 'benchmark'
       directory = File.realpath(options[:directory])
       api_map = nil
       time = Benchmark.measure {
-        api_map = Solargraph::ApiMap.load(directory)
+        api_map = Solargraph::ApiMap.load_with_cache(directory, $stdout)
         api_map.pins.each do |pin|
           begin
             puts pin_description(pin) if options[:verbose]
@@ -197,32 +226,13 @@ module Solargraph
     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: '.'
+    # @return [void]
     def list
       workspace = Solargraph::Workspace.new(options[:directory])
-      unless options[:count]
-        workspace.filenames.each { |f| puts f }
-      end
+      puts workspace.filenames unless options[:count]
       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
-      puts 'The `bundle` command is deprecated. Solargraph currently uses RBS instead.'
-    end
-
-    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
 
     # @param pin [Solargraph::Pin::Base]
@@ -240,5 +250,18 @@ module Solargraph
       desc += " (#{pin.location.filename} #{pin.location.range.start.line})" if pin.location
       desc
     end
+
+    # @param gemspec [Gem::Specification]
+    # @return [void]
+    def do_cache gemspec
+      cached = Yardoc.cached?(gemspec)
+      if cached && !options.rebuild
+        puts "Cache already exists for #{gemspec.name} #{gemspec.version}"
+      else
+        puts "#{cached ? 'Rebuilding' : 'Caching'} gem documentation for #{gemspec.name} #{gemspec.version}"
+        pins = GemPins.build(gemspec)
+        Cache.save('gems', "#{gemspec.name}-#{gemspec.version}.ser", pins)
+      end
+    end
   end
 end

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

@@ -0,0 +1,33 @@
+module Solargraph
+  class Source
+    class Chain
+      class Array < Literal
+        # @param children [::Array<Chain>]
+        def initialize children
+          super('::Array')
+          @children = children
+        end
+
+        def word
+          @word ||= "<#{@type}>"
+        end
+
+        # @param api_map [ApiMap]
+        # @param name_pin [Pin::Base]
+        # @param locals [Enumerable<Pin::LocalVariable>]
+        def resolve api_map, name_pin, locals
+          child_types = @children.map do |child|
+            child.infer(api_map, name_pin, locals)
+          end
+
+          type = if child_types.uniq.length == 1 && child_types.first.defined?
+                   ComplexType::UniqueType.new('Array', [], child_types.uniq, rooted: true, parameters_type: :list)
+                 else
+                   ComplexType::UniqueType.new('Array', rooted: true)
+                 end
+          [Pin::ProxyType.anonymous(type)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    class Chain
+      class BlockSymbol < Link
+        def resolve api_map, name_pin, locals
+          [Pin::ProxyType.anonymous(ComplexType.try_parse('::Proc'))]
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Solargraph
     class Chain
       class BlockVariable < Link
         def resolve api_map, name_pin, locals
-          [Pin::ProxyType.anonymous(ComplexType.try_parse('Proc'))]
+          [Pin::ProxyType.anonymous(ComplexType.try_parse('::Proc'))]
         end
       end
     end