solargraph 0.55.4 → 0.55.5

data/lib/solargraph/rbs_map/conversions.rb

@@ -6,7 +6,7 @@ module Solargraph
   class RbsMap
     # Functions for converting RBS declarations to Solargraph pins
     #
-    module Conversions
+    class Conversions
       include Logging
 
       # A container for tracking the current context of the RBS conversion
@@ -22,11 +22,17 @@ module Solargraph
         end
       end
 
-      # @return [Array<Pin::Base>]
-      def pins
-        @pins ||= []
+      def initialize(loader:)
+        @loader = loader
+        @pins = []
+        load_environment_to_pins(loader)
       end
 
+      attr_reader :loader
+
+      # @return [Array<Pin::Base>]
+      attr_reader :pins
+
       private
 
       # @return [Hash{String => RBS::AST::Declarations::TypeAlias}]
@@ -39,6 +45,10 @@ module Solargraph
       def load_environment_to_pins(loader)
         environment = RBS::Environment.from_loader(loader).resolve_type_names
         cursor = pins.length
+        if environment.declarations.empty?
+          Solargraph.logger.info "No RBS declarations found in environment for core_root #{loader.core_root.inspect}, libraries #{loader.libs} and directories #{loader.dirs}"
+          return
+        end
         environment.declarations.each { |decl| convert_decl_to_pin(decl, Solargraph::Pin::ROOT_PIN) }
       end
 
@@ -488,7 +498,7 @@ module Solargraph
           type_location: location_decl_to_pin_location(decl.location),
           closure: closure,
           comments: decl.comment&.string,
-          scope: :instance,
+          scope: final_scope,
           attribute: true,
           visibility: visibility,
           source: :rbs
@@ -512,7 +522,7 @@ module Solargraph
           closure: closure,
           parameters: [],
           comments: decl.comment&.string,
-          scope: :instance,
+          scope: final_scope,
           attribute: true,
           visibility: visibility,
           source: :rbs
@@ -628,11 +638,13 @@ module Solargraph
       # @param closure [Pin::Namespace]
       # @return [void]
       def alias_to_pin decl, closure
+        final_scope = decl.singleton? ? :class : :instance
         pins.push Solargraph::Pin::MethodAlias.new(
           name: decl.new_name.to_s,
           type_location: location_decl_to_pin_location(decl.location),
           original: decl.old_name.to_s,
           closure: closure,
+          scope: final_scope,
           source: :rbs,
         )
       end
@@ -683,8 +695,7 @@ module Solargraph
         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'
+          'undefined'
         elsif type.is_a?(RBS::Types::Bases::Bool)
           'Boolean'
         elsif type.is_a?(RBS::Types::Tuple)

data/lib/solargraph/rbs_map/core_map.rb

@@ -5,24 +5,46 @@ module Solargraph
     # Ruby core pins
     #
     class CoreMap
-      include Conversions
+
+      def resolved?
+        true
+      end
 
       FILLS_DIRECTORY = File.join(File.dirname(__FILE__), '..', '..', '..', 'rbs', 'fills')
 
-      def initialize
-        cache = Cache.load('core.ser')
+      def initialize; end
+
+      def pins
+        return @pins if @pins
+
+        @pins = []
+        cache = PinCache.deserialize_core
         if cache
-          pins.replace cache
+          @pins.replace cache
         else
-          loader = RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
           loader.add(path: Pathname(FILLS_DIRECTORY))
-          load_environment_to_pins(loader)
-          pins.concat RbsMap::CoreFills::ALL
+          @pins = conversions.pins
+          @pins.concat RbsMap::CoreFills::ALL
           processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
-          pins.replace processed
+          @pins.replace processed
 
-          Cache.save('core.ser', pins)
+          PinCache.serialize_core @pins
         end
+        @pins
+      end
+
+      def loader
+        @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
+      end
+
+      private
+
+      def loader
+        @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
+      end
+
+      def conversions
+        @conversions ||= Conversions.new(loader: loader)
       end
     end
   end

data/lib/solargraph/rbs_map/stdlib_map.rb

@@ -7,19 +7,29 @@ module Solargraph
     # Ruby stdlib pins
     #
     class StdlibMap < RbsMap
+      include Logging
+
       # @type [Hash{String => RbsMap}]
       @stdlib_maps_hash = {}
 
       # @param library [String]
       def initialize library
-        cache = Cache.load('stdlib', "#{library}.ser")
-        if cache
-          pins.replace cache
+        cached_pins = PinCache.deserialize_stdlib_require library
+        if cached_pins
+          @pins = cached_pins
           @resolved = true
+          @loaded = true
+          logger.debug { "Deserialized #{cached_pins.length} cached pins for stdlib require #{library.inspect}" }
         else
           super
-          return unless resolved?
-          Cache.save('stdlib', "#{library}.ser", pins)
+          unless resolved?
+            @pins = []
+            logger.info { "Could not resolve #{library.inspect}" }
+            return
+          end
+          generated_pins = pins
+          logger.debug { "Found #{generated_pins.length} pins for stdlib library #{library}" }
+          PinCache.serialize_stdlib_require library, generated_pins
         end
       end
 

data/lib/solargraph/rbs_map.rb

@@ -10,25 +10,78 @@ module Solargraph
     autoload :CoreFills,   'solargraph/rbs_map/core_fills'
     autoload :StdlibMap,   'solargraph/rbs_map/stdlib_map'
 
-    include Conversions
+    include Logging
 
     # @type [Hash{String => RbsMap}]
     @@rbs_maps_hash = {}
 
     attr_reader :library
 
+    attr_reader :rbs_collection_paths
+
+    attr_reader :rbs_collection_config_path
+
     # @param library [String]
     # @param version [String, nil]
-    # @param directories [Array<Pathname, String>]
-    def initialize library, version = nil, directories: []
+    # @param rbs_collection_paths [Array<Pathname, String>]
+    def initialize library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: []
+      if rbs_collection_config_path.nil? && !rbs_collection_paths.empty?
+        raise 'Please provide rbs_collection_config_path if you provide rbs_collection_paths'
+      end
       @library = library
       @version = version
-      @collection = nil
-      @directories = directories
-      loader = RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
+      @rbs_collection_config_path = rbs_collection_config_path
+      @rbs_collection_paths = rbs_collection_paths
       add_library loader, library, version
-      return unless resolved?
-      load_environment_to_pins(loader)
+    end
+
+    def loader
+      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
+    end
+
+    # @return string representing the version of the RBS info fetched
+    #   for the given library.  Must change when the RBS info is
+    #   updated upstream for the same library and version.  May change
+    #   if the config for where information comes form changes.
+    def cache_key
+      @hextdigest ||= begin
+        data = nil
+        if rbs_collection_config_path
+          lockfile_path = RBS::Collection::Config.to_lockfile_path(Pathname.new(rbs_collection_config_path))
+          if lockfile_path.exist?
+            collection_config = RBS::Collection::Config.from_path lockfile_path
+            gem_config = collection_config.gem(library)
+            data = gem_config&.to_s
+          end
+        end
+        if data.nil? || data.empty?
+          if resolved?
+            # definitely came from the gem itself and not elsewhere -
+            # only one version per gem
+            'gem-export'
+          else
+            'unresolved'
+          end
+        else
+          Digest::SHA1.hexdigest(data)
+        end
+      end
+    end
+
+    def self.from_gemspec gemspec, rbs_collection_path, rbs_collection_config_path
+      rbs_map = RbsMap.new(gemspec.name, gemspec.version,
+                           rbs_collection_paths: [rbs_collection_path].compact,
+                           rbs_collection_config_path: rbs_collection_config_path)
+      return rbs_map if rbs_map.resolved?
+
+      # try any version of the gem in the collection
+      RbsMap.new(gemspec.name, nil,
+                 rbs_collection_paths: [rbs_collection_path].compact,
+                 rbs_collection_config_path: rbs_collection_config_path)
+    end
+
+    def pins
+      @pins ||= resolved? ? conversions.pins : []
     end
 
     # @generic T
@@ -52,9 +105,10 @@ module Solargraph
 
     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)) }
+        @rbs_collection_paths.each do |dir|
+          dir_path = Pathname.new(dir)
+          repo.add(dir_path) if dir_path.exist? && dir_path.directory?
+        end
       end
     end
 
@@ -64,12 +118,15 @@ module Solargraph
       @@rbs_maps_hash[library] ||= RbsMap.new(library)
     end
 
-    # @param gemspec [Gem::Specification]
-    def self.from_gemspec(gemspec)
-      RbsMap.new(gemspec.name, gemspec.version)
+    private
+
+    def loader
+      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
     end
 
-    private
+    def conversions
+      @conversions ||= Conversions.new(loader: loader)
+    end
 
     # @param loader [RBS::EnvironmentLoader]
     # @param library [String]
@@ -77,10 +134,10 @@ module Solargraph
     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}"
+        logger.debug { "#{short_name} successfully loaded library #{library}:#{version}" }
         true
       else
-        Solargraph.logger.info "#{short_name} failed to load library #{library}"
+        logger.info { "#{short_name} did not find data for library #{library}:#{version}" }
         false
       end
     end

data/lib/solargraph/shell.rb

@@ -90,19 +90,20 @@ module Solargraph
     # @return [void]
     def clear
       puts "Deleting all cached documentation (gems, core and stdlib)"
-      Solargraph::Cache.clear
+      Solargraph::PinCache.clear
     end
     map 'clear-cache' => :clear
     map 'clear-cores' => :clear
 
     desc 'cache', 'Cache a gem', hide: true
+    option :rebuild, type: :boolean, desc: 'Rebuild existing documentation', default: false
     # @return [void]
     # @param gem [String]
     # @param version [String, nil]
     def cache gem, version = nil
+      api_map = Solargraph::ApiMap.load(Dir.pwd)
       spec = Gem::Specification.find_by_name(gem, version)
-      pins = GemPins.build(spec)
-      Cache.save('gems', "#{spec.name}-#{spec.version}.ser", pins)
+      api_map.cache_gem(spec, rebuild: options[:rebuild], out: $stdout)
     end
 
     desc 'uncache GEM [...GEM]', "Delete specific cached gem documentation"
@@ -117,18 +118,17 @@ module Solargraph
       raise ArgumentError, 'No gems specified.' if gems.empty?
       gems.each do |gem|
         if gem == 'core'
-          Cache.uncache("core.ser")
+          PinCache.uncache_core
           next
         end
 
         if gem == 'stdlib'
-          Cache.uncache("stdlib")
+          PinCache.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")
+        PinCache.uncache_gem(spec, out: $stdout)
       end
     end
 
@@ -257,14 +257,10 @@ module Solargraph
     # @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
+      api_map = ApiMap.load('.')
+      # @todo if the rebuild: option is passed as a positional arg,
+      #   typecheck doesn't complain on the below line
+      api_map.cache_gem(gemspec, rebuild: options.rebuild, out: $stdout)
     end
   end
 end

data/lib/solargraph/source_map.rb

@@ -118,23 +118,6 @@ module Solargraph
       _locate_pin line, character, Pin::Namespace, Pin::Method, Pin::Block
     end
 
-    # @todo Candidate for deprecation
-    #
-    # @param other_map [SourceMap]
-    # @return [Boolean]
-    def try_merge! other_map
-      return false if pins.length != other_map.pins.length || locals.length != other_map.locals.length || requires.map(&:name).uniq.sort != other_map.requires.map(&:name).uniq.sort
-
-      pins.each_index do |i|
-        return false unless pins[i].try_merge!(other_map.pins[i])
-      end
-      locals.each_index do |i|
-        return false unless locals[i].try_merge!(other_map.locals[i])
-      end
-      @source = other_map.source
-      true
-    end
-
     # @param name [String]
     # @return [Array<Location>]
     def references name

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.55.4'
+  VERSION = '0.55.5'
 end

data/lib/solargraph/views/_method.erb

@@ -2,33 +2,33 @@
     Namespace:
 </h2>
 <p>
-    <a href="solargraph:/document?query=<%= CGI.escape object.namespace.path %>"><%= object.namespace %></a>
+    <a href="solargraph:/document?query=<%= CGI.escape pin.namespace.path %>"><%= pin.namespace %></a>
 </p>
 <h2>
     Overview:
 </h2>
-<%= htmlify object.docstring %>
+<%= htmlify pin.docstring %>
 <p class="document-section">
-    <big><strong>Visibility:</strong></big> <%= object.visibility %>
+    <big><strong>Visibility:</strong></big> <%= pin.visibility %>
 </p>
-<% unless object.tags(:param).empty? %>
+<% unless pin.docstring.tags(:param).empty? %>
     <h2>
         Parameters:
     </h2>
     <ul>
-        <% object.tags(:param).each do |tag| %>
+        <% pin.docstring.tags(:param).each do |tag| %>
             <li>
                 <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
             </li>
         <% end %>
     </ul>
 <% end %>
-<% unless object.tags(:raise).empty? %>
+<% unless pin.docstring.tags(:raise).empty? %>
 <h2>
     Raises:
 </h2>
 <ul>
-    <% object.tags(:raise).each do |tag| %>
+    <% pin.docstring.tags(:raise).each do |tag| %>
         <li>
             <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
         </li>
@@ -38,20 +38,20 @@
 <h2>
     Returns:
 </h2>
-<% if object.tag(:return).nil? %>
+<% if pin.docstring.tag(:return).nil? %>
     <p>
         Undefined/unknown
     </p>
 <% else %>
     <ul>
-        <% object.tags(:return).each do |tag| %>
+        <% pin.tags(:return).each do |tag| %>
             <li>
                 <%= erb :_name_type_tag, layout: false, locals: {tag: tag} %>
             </li>
         <% end %>
     </ul>
 <% end %>
-<% examples = object.tags(:example) %>
+<% examples = pin.docstring.tags(:example) %>
 <% unless examples.nil? %>
     <% examples.each do |example| %>
         <h2>

data/lib/solargraph/views/_namespace.erb

@@ -1,12 +1,12 @@
 <h2>
     Overview:
 </h2>
-<%= htmlify object.docstring %>
+<%= htmlify pin.docstring %>
 <h2>
     Class Methods
 </h2>
 <ul class="doc-list">
-    <% object.meths(scope: :class).sort{|a, b| a.name <=> b.name}.each do |meth| %>
+    <% api_map.get_methods(pin.path, scope: :class, deep: false).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
             <a href="solargraph:/document?query=<%= CGI.escape(meth.path) %>"><%= meth.name %></a>
         </li>
@@ -16,7 +16,7 @@
     Instance Methods
 </h2>
 <ul class="doc-list">
-    <% object.meths(scope: :instance).sort{|a, b| a.name <=> b.name}.each do |meth| %>
+    <% api_map.get_methods(pin.path, scope: :instance, deep: false).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
             <a href="solargraph:/document?query=<%= CGI.escape(meth.path) %>"><%= meth.name %></a>
         </li>

data/lib/solargraph/views/document.erb

@@ -1,23 +1,23 @@
-<% objects.reverse.each do |object| %>
+<% pins.each do |pin| %>
     <h1>
-        <%= object.name %>
-        <% if object.is_a?(YARD::CodeObjects::MethodObject) and !object.parameters.empty? %>
-            <small>(<%= object.parameters.map {|p| "#{p[0]}#{p[1] and p[0].end_with?(':') ? ' ' : (p[1] ? ' = ' : '')}#{p[1]}"}.join(', ') %>)</small>
+        <%= pin.name %>
+        <% if pin.is_a?(Solargraph::Pin::Method) && !pin.parameters.empty? %>
+            <small>(<%= pin.parameters.map {|p| "#{p[0]}#{p[1] and p[0].end_with?(':') ? ' ' : (p[1] ? ' = ' : '')}#{p[1]}"}.join(', ') %>)</small>
         <% end %>
     </h1>
-    <% unless object.files.empty? %>
+    <% unless pins.map(&:location).compact.empty? %>
         <h2>
             Defined in:
         </h2>
         <ul>
-            <% object.files.each do |f| %>
+            <% pins.map(&:location).compact.map(&:filename).each do |f| %>
                 <li><%= f %></li>
             <% end %>
         </ul>
     <% end %>
-    <% if object.is_a?(YARD::CodeObjects::NamespaceObject) %>
-        <%= erb :_namespace, layout: false, locals: {object: object} %>
-    <% elsif object.is_a?(YARD::CodeObjects::MethodObject) %>
-        <%= erb :_method, layout: false, locals: {object: object} %>
+    <% if pin.is_a?(Solargraph::Pin::Namespace) %>
+        <%= erb :_namespace, layout: false, locals: {api_map: api_map, pin: pin} %>
+    <% elsif pin.is_a?(Solargraph::Pin::Method) %>
+        <%= erb :_method, layout: false, locals: {api_map: api_map, pin: pin} %>
     <% end %>
 <% end %>

data/lib/solargraph/workspace.rb

@@ -106,7 +106,7 @@ module Solargraph
     def would_require? path
       require_paths.each do |rp|
         full = File.join rp, path
-        return true if File.exist?(full) or File.exist?(full << ".rb")
+        return true if File.file?(full) || File.file?(full << ".rb")
       end
       false
     end
@@ -133,6 +133,15 @@ module Solargraph
       @gem_rbs_collection ||= read_rbs_collection_path
     end
 
+    def rbs_collection_config_path
+      @rbs_collection_config_path ||= begin
+        unless directory.empty? || directory == '*'
+          yaml_file = File.join(directory, 'rbs_collection.yaml')
+          yaml_file if File.file?(yaml_file)
+        end
+      end
+    end
+
     # Synchronize the workspace from the provided updater.
     #
     # @param updater [Source::Updater]
@@ -214,7 +223,7 @@ module Solargraph
     def configured_require_paths
       return ['lib'] if directory.empty?
       return [File.join(directory, 'lib')] if config.require_paths.empty?
-      config.require_paths.map{|p| File.join(directory, p)}
+      config.require_paths.map { |p| File.join(directory, p) }
     end
 
     # @return [void]
@@ -230,10 +239,11 @@ module Solargraph
 
     # @return [String, nil]
     def read_rbs_collection_path
-      yaml_file = File.join(directory, 'rbs_collection.yaml')
-      return unless File.file?(yaml_file)
+      return unless rbs_collection_config_path
 
-      YAML.load_file(yaml_file)&.fetch('path')
+      path = YAML.load_file(rbs_collection_config_path)&.fetch('path')
+      # make fully qualified
+      File.expand_path(path, directory)
     end
   end
 end

data/lib/solargraph/yardoc.rb

@@ -12,7 +12,7 @@ module Solargraph
     # @param gemspec [Gem::Specification]
     # @return [String] The path to the cached yardoc.
     def cache(gemspec)
-      path = path_for(gemspec)
+      path = PinCache.yardoc_path gemspec
       return path if cached?(gemspec)
 
       Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
@@ -26,18 +26,10 @@ module Solargraph
     #
     # @param gemspec [Gem::Specification]
     def cached?(gemspec)
-      yardoc = File.join(path_for(gemspec), 'complete')
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
       File.exist?(yardoc)
     end
 
-    # Get the absolute path for a cached gem yardoc.
-    #
-    # @param gemspec [Gem::Specification]
-    # @return [String]
-    def path_for(gemspec)
-      File.join(Solargraph::Cache.base_dir, "yard-#{YARD::VERSION}", "#{gemspec.name}-#{gemspec.version}.yardoc")
-    end
-
     # Load a gem's yardoc and return its code objects.
     #
     # @note This method modifies the global YARD registry.
@@ -45,7 +37,7 @@ module Solargraph
     # @param gemspec [Gem::Specification]
     # @return [Array<YARD::CodeObjects::Base>]
     def load!(gemspec)
-      YARD::Registry.load! path_for(gemspec)
+      YARD::Registry.load! PinCache.yardoc_path gemspec
       YARD::Registry.all
     end
   end

data/lib/solargraph.rb

@@ -48,23 +48,21 @@ module Solargraph
   autoload :Parser,           'solargraph/parser'
   autoload :RbsMap,           'solargraph/rbs_map'
   autoload :GemPins,          'solargraph/gem_pins'
-  autoload :Cache,            'solargraph/cache'
+  autoload :PinCache,         'solargraph/pin_cache'
 
   dir = File.dirname(__FILE__)
   VIEWS_PATH = File.join(dir, 'solargraph', 'views')
 
-  # @param type [Symbol] Type of assert.  Not used yet, but may be
-  #   used in the future to allow configurable asserts mixes for
-  #   different situations.
+  # @param type [Symbol] Type of assert.
   def self.asserts_on?(type)
-    @asserts_on ||= if ENV['SOLARGRAPH_ASSERTS'].nil? || ENV['SOLARGRAPH_ASSERTS'].empty?
-                      false
-                    elsif ENV['SOLARGRAPH_ASSERTS'] == 'on'
-                      true
-                    else
-                      logger.warn "Unrecognized SOLARGRAPH_ASSERTS value: #{ENV['SOLARGRAPH_ASSERTS']}"
-                      false
-                    end
+    if ENV['SOLARGRAPH_ASSERTS'].nil? || ENV['SOLARGRAPH_ASSERTS'].empty?
+      false
+    elsif ENV['SOLARGRAPH_ASSERTS'] == 'on'
+      true
+    else
+      logger.warn "Unrecognized SOLARGRAPH_ASSERTS value: #{ENV['SOLARGRAPH_ASSERTS']}"
+      false
+    end
   end
 
   def self.assert_or_log(type, msg = nil, &block)

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true