solargraph 0.47.2 → 0.54.0

data/lib/solargraph/rbs_map/stdlib_map.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+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
+          @resolved = true
+        else
+          super
+          return unless resolved?
+          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
+    end
+  end
+end

data/lib/solargraph/rbs_map.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rbs'
+
+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 :StdlibMap,   'solargraph/rbs_map/stdlib_map'
+
+    include Conversions
+
+    # @type [Hash{String => RbsMap}]
+    @@rbs_maps_hash = {}
+
+    attr_reader :library
+
+    # @param library [String]
+    # @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, version
+      return unless resolved?
+      load_environment_to_pins(loader)
+    end
+
+    # @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
+
+    def resolved?
+      @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 self.from_gemspec(gemspec)
+      RbsMap.new(gemspec.name, gemspec.version)
+    end
+
+    private
+
+    # @param loader [RBS::EnvironmentLoader]
+    # @param library [String]
+    # @return [Boolean] true if adding the library succeeded
+    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}"
+        false
+      end
+    end
+
+    # @return [String]
+    def short_name
+      self.class.name.split('::').last
+    end
+  end
+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,59 +83,57 @@ 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'
-    def list_cores
-      puts Solargraph::YardMap::CoreDocs.versions.join("\n")
-    end
-
-    desc 'available-cores', 'List available documentation versions'
-    def available_cores
-      puts Solargraph::YardMap::CoreDocs.available.join("\n")
-    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.
     )
+    # @return [void]
     def clear
       puts "Deleting the cached documentation"
-      Solargraph::YardMap::CoreDocs.clear
+      Solargraph::Cache.clear
     end
     map 'clear-cache' => :clear
     map 'clear-cores' => :clear
 
+    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 cached gem documentation"
+    # @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
+        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
@@ -137,26 +147,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
 
@@ -169,12 +186,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]
@@ -191,18 +208,14 @@ module Solargraph
       puts "Scanned #{directory} (#{api_map.pins.length} pins) in #{time.real} seconds."
     end
 
-    desc 'bundle', 'Generate documentation for bundled gems'
-    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
-    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 '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])
+      puts workspace.filenames unless options[:count]
+      puts "#{workspace.filenames.length} files total."
     end
 
     private
@@ -222,5 +235,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,32 @@
+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).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

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