solargraph 0.47.2 → 0.53.3

data/lib/solargraph/api_map.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'rubygems'
-require 'set'
 require 'pathname'
 require 'yard'
-require 'yard-solargraph'
+require 'solargraph/yard_tags'
 
 module Solargraph
   # An aggregate provider for information about workspaces, sources, gems, and
@@ -14,13 +12,12 @@ module Solargraph
     autoload :Cache,          'solargraph/api_map/cache'
     autoload :SourceToYard,   'solargraph/api_map/source_to_yard'
     autoload :Store,          'solargraph/api_map/store'
-    autoload :BundlerMethods, 'solargraph/api_map/bundler_methods'
-
-    include SourceToYard
 
     # @return [Array<String>]
     attr_reader :unresolved_requires
 
+    @@core_map = RbsMap::CoreMap.new
+
     # @return [Array<String>]
     attr_reader :missing_docs
 
@@ -40,7 +37,7 @@ module Solargraph
       @source_map_hash = {}
       implicit.clear
       cache.clear
-      @store = Store.new(yard_map.pins + pins)
+      @store = Store.new(@@core_map.pins + pins)
       self
     end
 
@@ -57,32 +54,41 @@ module Solargraph
     # Catalog a bench.
     #
     # @param bench [Bench]
+    # @return [self]
     def catalog bench
       implicit.clear
       @cache.clear
       @source_map_hash = bench.source_maps.map { |s| [s.filename, s] }.to_h
       pins = bench.source_maps.map(&:pins).flatten
-      external_requires = bench.external_requires
       source_map_hash.each_value do |map|
         implicit.merge map.environ
       end
-      external_requires.merge implicit.requires
-      external_requires.merge bench.workspace.config.required
-      yard_map.change(external_requires, bench.workspace.directory, bench.workspace.source_gems)
-      @store = Store.new(yard_map.pins + implicit.pins + pins)
-      @unresolved_requires = yard_map.unresolved_requires
-      @missing_docs = yard_map.missing_docs
-      @rebindable_method_names = nil
+      unresolved_requires = (bench.external_requires + implicit.requires + bench.workspace.config.required).uniq
+      @doc_map = DocMap.new(unresolved_requires, []) # @todo Implement gem preferences
+      @store = Store.new(@@core_map.pins + @doc_map.pins + implicit.pins + pins)
+      @unresolved_requires = @doc_map.unresolved_requires
+      @missing_docs = [] # @todo Implement missing docs
       store.block_pins.each { |blk| blk.rebind(self) }
       self
     end
 
+    # @return [::Array<Gem::Specification>]
+    def uncached_gemspecs
+      @doc_map&.uncached_gemspecs || []
+    end
+
+    # @return [Array<Pin::Base>]
+    def core_pins
+      @@core_map.pins
+    end
+
     # @param name [String]
     # @return [YARD::Tags::MacroDirective, nil]
     def named_macro name
       store.named_macros[name]
     end
 
+    # @return [Set<String>]
     def required
       @required ||= Set.new
     end
@@ -108,7 +114,7 @@ module Solargraph
     # @return [SourceMap::Clip]
     def clip_at filename, position
       position = Position.normalize(position)
-      SourceMap::Clip.new(self, cursor_at(filename, position))
+      clip(cursor_at(filename, position))
     end
 
     # Create an ApiMap with a workspace in the specified directory.
@@ -125,21 +131,28 @@ module Solargraph
       api_map
     end
 
+    # Create an ApiMap with a workspace in the specified directory and cache
+    # any missing gems.
+    #
+    # @param directory [String]
+    # @return [ApiMap]
+    def self.load_with_cache directory
+      api_map = load(directory)
+      return api_map if api_map.uncached_gemspecs.empty?
+
+      api_map.uncached_gemspecs.each do |gemspec|
+        Solargraph.logger.info "Caching #{gemspec.name} #{gemspec.version}..."
+        pins = GemPins.build(gemspec)
+        Solargraph::Cache.save('gems', "#{gemspec.name}-#{gemspec.version}.ser", pins)
+      end
+      load(directory)
+    end
+
     # @return [Array<Solargraph::Pin::Base>]
     def pins
       store.pins
     end
 
-    def rebindable_method_names
-      @rebindable_method_names ||= begin
-        result = yard_map.rebindable_method_names
-        source_maps.each do |map|
-          result.merge map.rebindable_method_names
-        end
-        result
-      end
-    end
-
     # An array of pins based on Ruby keywords (`if`, `end`, etc.).
     #
     # @return [Enumerable<Solargraph::Pin::Keyword>]
@@ -186,22 +199,55 @@ module Solargraph
       result
     end
 
-    # Get a fully qualified namespace name. This method will start the search
-    # in the specified context until it finds a match for the name.
+    # @param namespace [String]
+    # @param context [String]
+    # @return [Array<Pin::Namespace>]
+    def get_namespace_pins namespace, context
+      store.fqns_pins(qualify(namespace, context))
+    end
+
+    # Determine fully qualified tag for a given tag used inside the
+    # definition of another tag ("context"). This method will start
+    # the search in the specified context until it finds a match for
+    # the tag.
+    #
+    # Does not recurse into qualifying the type parameters, but
+    # returns any which were passed in unchanged.
+    #
+    # @param tag [String, nil] The namespace to
+    #   match, complete with generic parameters set to appropriate
+    #   values if available
+    # @param context_tag [String] The context in which the tag was
+    #   referenced; start from here to resolve the name
+    # @return [String, nil] fully qualified tag
+    def qualify tag, context_tag = ''
+      return tag if ['self', nil].include?(tag)
+      context_type = ComplexType.parse(context_tag)
+      type = ComplexType.parse(tag)
+      fqns = qualify_namespace(type.rooted_namespace, context_type.rooted_namespace)
+      return nil if fqns.nil?
+      fqns + type.substring
+    end
+
+    # Determine fully qualified namespace for a given namespace used
+    # inside the definition of another tag ("context"). This method
+    # will start the search in the specified context until it finds a
+    # match for the namespace.
     #
-    # @param namespace [String, nil] The namespace to match
-    # @param context [String] The context to search
-    # @return [String]
-    def qualify namespace, context = ''
-      return namespace if ['self', nil].include?(namespace)
-      cached = cache.get_qualified_namespace(namespace, context)
+    # @param namespace [String, nil] The namespace to
+    #   match
+    # @param context_namespace [String] The context namespace in which the
+    #   tag was referenced; start from here to resolve the name
+    # @return [String, nil] fully qualified namespace
+    def qualify_namespace(namespace, context_namespace = '')
+      cached = cache.get_qualified_namespace(namespace, context_namespace)
       return cached.clone unless cached.nil?
       result = if namespace.start_with?('::')
                  inner_qualify(namespace[2..-1], '', Set.new)
                else
-                 inner_qualify(namespace, context, Set.new)
+                 inner_qualify(namespace, context_namespace, Set.new)
                end
-      cache.set_qualified_namespace(namespace, context, result)
+      cache.set_qualified_namespace(namespace, context_namespace, result)
       result
     end
 
@@ -227,49 +273,50 @@ module Solargraph
     # Get an array of class variable pins for a namespace.
     #
     # @param namespace [String] A fully qualified namespace
-    # @return [Array<Solargraph::Pin::ClassVariable>]
+    # @return [Enumerable<Solargraph::Pin::ClassVariable>]
     def get_class_variable_pins(namespace)
       prefer_non_nil_variables(store.get_class_variables(namespace))
     end
 
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def get_symbols
       store.get_symbols
     end
 
-    # @return [Array<Solargraph::Pin::GlobalVariable>]
+    # @return [Enumerable<Solargraph::Pin::GlobalVariable>]
     def get_global_variable_pins
       store.pins_by_class(Pin::GlobalVariable)
     end
 
     # Get an array of methods available in a particular context.
     #
-    # @param fqns [String] The fully qualified namespace to search for methods
+    # @param rooted_tag [String] The fully qualified namespace to search for methods
     # @param scope [Symbol] :class or :instance
     # @param visibility [Array<Symbol>] :public, :protected, and/or :private
     # @param deep [Boolean] True to include superclasses, mixins, etc.
     # @return [Array<Solargraph::Pin::Method>]
-    def get_methods fqns, scope: :instance, visibility: [:public], deep: true
-      cached = cache.get_methods(fqns, scope, visibility, deep)
+    def get_methods rooted_tag, scope: :instance, visibility: [:public], deep: true
+      cached = cache.get_methods(rooted_tag, scope, visibility, deep)
       return cached.clone unless cached.nil?
       result = []
       skip = Set.new
-      if fqns == ''
+      if rooted_tag == ''
         # @todo Implement domains
         implicit.domains.each do |domain|
           type = ComplexType.try_parse(domain)
           next if type.undefined?
           result.concat inner_get_methods(type.name, type.scope, visibility, deep, skip)
         end
-        result.concat inner_get_methods(fqns, :class, visibility, deep, skip)
-        result.concat inner_get_methods(fqns, :instance, visibility, deep, skip)
+        result.concat inner_get_methods(rooted_tag, :class, visibility, deep, skip)
+        result.concat inner_get_methods(rooted_tag, :instance, visibility, deep, skip)
         result.concat inner_get_methods('Kernel', :instance, visibility, deep, skip)
       else
-        result.concat inner_get_methods(fqns, scope, visibility, deep, skip)
+        result.concat inner_get_methods(rooted_tag, scope, visibility, deep, skip)
         result.concat inner_get_methods('Kernel', :instance, [:public], deep, skip) if visibility.include?(:private)
+        result.concat inner_get_methods('Module', scope, visibility, deep, skip)
       end
       resolved = resolve_method_aliases(result, visibility)
-      cache.set_methods(fqns, scope, visibility, deep, resolved)
+      cache.set_methods(rooted_tag, scope, visibility, deep, resolved)
       resolved
     end
 
@@ -307,27 +354,27 @@ module Solargraph
               visibility.push :protected
               visibility.push :private if internal
             end
-            result.merge get_methods(type.namespace, scope: type.scope, visibility: visibility)
+            result.merge get_methods(type.tag, scope: type.scope, visibility: visibility)
           end
         end
       end
       result.to_a
     end
 
-    # Get a stack of method pins for a method name in a namespace. The order
-    # of the pins corresponds to the ancestry chain, with highest precedence
-    # first.
+    # Get a stack of method pins for a method name in a potentially
+    # parameterized namespace. The order of the pins corresponds to
+    # the ancestry chain, with highest precedence first.
     #
     # @example
     #   api_map.get_method_stack('Subclass', 'method_name')
     #     #=> [ <Subclass#method_name pin>, <Superclass#method_name pin> ]
     #
-    # @param fqns [String]
-    # @param name [String]
+    # @param rooted_tag [String] Parameterized namespace, fully qualified
+    # @param name [String] Method name to look up
     # @param scope [Symbol] :instance or :class
     # @return [Array<Solargraph::Pin::Method>]
-    def get_method_stack fqns, name, scope: :instance
-      get_methods(fqns, scope: scope, visibility: [:private, :protected, :public]).select { |p| p.name == name }
+    def get_method_stack rooted_tag, name, scope: :instance
+      get_methods(rooted_tag, scope: scope, visibility: [:private, :protected, :public]).select { |p| p.name == name }
     end
 
     # Get an array of all suggestions that match the specified path.
@@ -335,7 +382,7 @@ module Solargraph
     # @deprecated Use #get_path_pins instead.
     #
     # @param path [String] The path to find
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def get_path_suggestions path
       return [] if path.nil?
       resolve_method_aliases store.get_path_pins(path)
@@ -344,7 +391,7 @@ module Solargraph
     # Get an array of pins that match the specified path.
     #
     # @param path [String]
-    # @return [Array<Pin::Base>]
+    # @return [Enumerable<Pin::Base>]
     def get_path_pins path
       get_path_suggestions(path)
     end
@@ -357,15 +404,9 @@ module Solargraph
     # @param query [String] The text to match
     # @return [Array<String>]
     def search query
-      rake_yard(store)
-      found = []
-      code_object_paths.each do |k|
-        if (found.empty? || (query.include?('.') || query.include?('#')) || !(k.include?('.') || k.include?('#'))) &&
-           k.downcase.include?(query.downcase)
-          found.push k
-        end
-      end
-      found
+      pins.map(&:path)
+          .compact
+          .select { |path| path.downcase.include?(query.downcase) }
     end
 
     # Get YARD documentation for the specified path.
@@ -373,13 +414,13 @@ module Solargraph
     # @example
     #   api_map.document('String#split')
     #
+    # @todo This method is likely superfluous. Calling get_path_pins directly
+    #   should be sufficient.
+    #
     # @param path [String] The path to find
-    # @return [Array<YARD::CodeObjects::Base>]
+    # @return [Enumerable<Pin::Base>]
     def document path
-      rake_yard(store)
-      docs = []
-      docs.push code_object_at(path) unless code_object_at(path).nil?
-      docs
+      get_path_pins(path)
     end
 
     # Get an array of all symbols in the workspace that match the query.
@@ -405,6 +446,10 @@ module Solargraph
     # @return [SourceMap::Clip]
     def clip cursor
       raise FileNotFoundError, "ApiMap did not catalog #{cursor.filename}" unless source_map_hash.key?(cursor.filename)
+
+      # @todo Clip caches are disabled pending resolution of a stale cache bug
+      # cache.get_clip(cursor) ||
+      #   SourceMap::Clip.new(self, cursor).tap { |clip| cache.set_clip(cursor, clip) }
       SourceMap::Clip.new(self, cursor)
     end
 
@@ -447,25 +492,24 @@ module Solargraph
     def super_and_sub?(sup, sub)
       fqsup = qualify(sup)
       cls = qualify(sub)
-      until fqsup.nil? || cls.nil?
+      tested = []
+      until fqsup.nil? || cls.nil? || tested.include?(cls)
         return true if cls == fqsup
+        tested.push cls
         cls = qualify_superclass(cls)
       end
       false
     end
 
-    # @return [YardMap]
-    def yard_map
-      @yard_map ||= YardMap.new
-    end
-
-    # Check if the host class includes the specified module.
+    # Check if the host class includes the specified module, ignoring
+    # type parameters used.
+    #
+    # @param host_ns [String] The class namesapce (no type parameters)
+    # @param module_ns [String] The module namespace (no type parameters)
     #
-    # @param host [String] The class
-    # @param mod [String] The module
     # @return [Boolean]
-    def type_include?(host, mod)
-      store.get_includes(host).include?(mod)
+    def type_include?(host_ns, module_ns)
+      store.get_includes(host_ns).map { |inc_tag| ComplexType.parse(inc_tag).name }.include?(module_ns)
     end
 
     private
@@ -483,15 +527,19 @@ module Solargraph
     # @return [Solargraph::ApiMap::Cache]
     attr_reader :cache
 
-    # @param fqns [String] A fully qualified namespace
+    # @param rooted_tag [String] A fully qualified namespace, with
+    #   generic parameter values if applicable
     # @param scope [Symbol] :class or :instance
     # @param visibility [Array<Symbol>] :public, :protected, and/or :private
     # @param deep [Boolean]
     # @param skip [Set<String>]
     # @param no_core [Boolean] Skip core classes if true
     # @return [Array<Pin::Base>]
-    def inner_get_methods fqns, scope, visibility, deep, skip, no_core = false
-      return [] if no_core && fqns =~ /^(Object|BasicObject|Class|Module|Kernel)$/
+    def inner_get_methods rooted_tag, scope, visibility, deep, skip, no_core = false
+      rooted_type = ComplexType.parse(rooted_tag)
+      fqns = rooted_type.namespace
+      fqns_generic_params = rooted_type.all_params
+      return [] if no_core && fqns =~ /^(Object|BasicObject|Class|Module)$/
       reqstr = "#{fqns}|#{scope}|#{visibility.sort}|#{deep}"
       return [] if skip.include?(reqstr)
       skip.add reqstr
@@ -502,12 +550,33 @@ module Solargraph
           result.concat inner_get_methods(fqim, scope, visibility, deep, skip, true) unless fqim.nil?
         end
       end
-      result.concat store.get_methods(fqns, scope: scope, visibility: visibility).sort{ |a, b| a.name <=> b.name }
+      # Store#get_methods doesn't know about full tags, just
+      # namespaces; resolving the generics in the method pins is this
+      # class' responsibility
+      raw_methods = store.get_methods(fqns, scope: scope, visibility: visibility).sort{ |a, b| a.name <=> b.name }
+      namespace_pin = store.get_path_pins(fqns).select{|p| p.is_a?(Pin::Namespace)}.first
+      methods = if rooted_tag != fqns
+                  methods = raw_methods.map do |method_pin|
+                    method_pin.resolve_generics(namespace_pin, rooted_type)
+                  end
+                else
+                  raw_methods
+                end
+      result.concat methods
       if deep
         if scope == :instance
-          store.get_includes(fqns).reverse.each do |im|
-            fqim = qualify(im, fqns)
-            result.concat inner_get_methods(fqim, scope, visibility, deep, skip, true) unless fqim.nil?
+          store.get_includes(fqns).reverse.each do |include_tag|
+            rooted_include_tag = qualify(include_tag, rooted_tag)
+            # Ensure the types returned by the included methods are
+            # relative to the generics passed to the include.  e.g.,
+            # Foo<String> might include Enumerable<String>
+            #
+            # @todo perform the same translation in the other areas
+            #  here after adding a spec and handling things correctly
+            #  in ApiMap::Store and RbsMap::Conversions
+            resolved_include_type = ComplexType.parse(rooted_include_tag).resolve_generics(namespace_pin, rooted_type)
+            methods = inner_get_methods(resolved_include_type.tag, scope, visibility, deep, skip, true)
+            result.concat methods
           end
           fqsc = qualify_superclass(fqns)
           unless fqsc.nil?
@@ -571,6 +640,8 @@ module Solargraph
       qualify namespace, context.split('::')[0..-2].join('::')
     end
 
+    # @param fqsub [String]
+    # @return [String, nil]
     def qualify_superclass fqsub
       sup = store.get_superclass(fqsub)
       return nil if sup.nil?
@@ -580,11 +651,12 @@ module Solargraph
       qualify(sup, parts.join('::'))
     end
 
-    # @param name [String]
-    # @param root [String]
-    # @param skip [Set<String>]
-    # @return [String, nil]
+    # @param name [String] Namespace to fully qualify
+    # @param root [String] The context to search
+    # @param skip [Set<String>] Contexts already searched
+    # @return [String, nil] Fully qualified ("rooted") namespace
     def inner_qualify name, root, skip
+      return name if name == ComplexType::GENERIC_TAG_NAME
       return nil if name.nil?
       return nil if skip.include?(root)
       skip.add root
@@ -634,8 +706,8 @@ module Solargraph
 
     # Sort an array of pins to put nil or undefined variables last.
     #
-    # @param pins [Array<Solargraph::Pin::Base>]
-    # @return [Array<Solargraph::Pin::Base>]
+    # @param pins [Enumerable<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def prefer_non_nil_variables pins
       result = []
       nil_pins = []
@@ -649,8 +721,8 @@ module Solargraph
       result + nil_pins
     end
 
-    # @param pins [Array<Pin::Base>]
-    # @param visibility [Array<Symbol>]
+    # @param pins [Enumerable<Pin::Base>]
+    # @param visibility [Enumerable<Symbol>]
     # @return [Array<Pin::Base>]
     def resolve_method_aliases pins, visibility = [:public, :private, :protected]
       result = []
@@ -667,7 +739,7 @@ module Solargraph
     def resolve_method_alias pin
       return pin if !pin.is_a?(Pin::MethodAlias) || @method_alias_stack.include?(pin.path)
       @method_alias_stack.push pin.path
-      origin = get_method_stack(pin.full_context.namespace, pin.original, scope: pin.scope).first
+      origin = get_method_stack(pin.full_context.tag, pin.original, scope: pin.scope).first
       @method_alias_stack.pop
       return pin if origin.nil?
       args = {
@@ -677,7 +749,7 @@ module Solargraph
         comments: origin.comments,
         scope: origin.scope,
         visibility: origin.visibility,
-        parameters: origin.parameters,
+        signatures: origin.signatures,
         attribute: origin.attribute?
       }
       Pin::Method.new **args

data/lib/solargraph/bench.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
 
 module Solargraph
   # A container of source maps and workspace data to be cataloged in an ApiMap.
@@ -21,7 +20,9 @@ module Solargraph
     def initialize source_maps: [], workspace: Workspace.new, external_requires: []
       @source_maps = source_maps.to_set
       @workspace = workspace
-      @external_requires = external_requires.to_set
+      @external_requires = external_requires.reject { |path| workspace.would_require?(path) }
+                                            .compact
+                                            .to_set
     end
   end
 end

data/lib/solargraph/cache.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+require 'rbs'
+
+module Solargraph
+  module Cache
+    class << self
+      # The base directory where cached documentation is installed.
+      #
+      # @return [String]
+      def base_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        ENV['SOLARGRAPH_CACHE'] ||
+          (ENV['XDG_CACHE_HOME'] ? File.join(ENV['XDG_CACHE_HOME'], 'solargraph') : nil) ||
+          File.join(Dir.home, '.cache', 'solargraph')
+      end
+
+      # The working directory for the current Ruby, RBS, and Solargraph versions.
+      #
+      # @return [String]
+      def work_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        File.join(base_dir, "ruby-#{RUBY_VERSION}", "rbs-#{RBS::VERSION}", "solargraph-#{Solargraph::VERSION}")
+      end
+
+      # Append the given path to the current cache directory (`work_dir`).
+      #
+      # @example
+      #   Cache.join('date-3.4.1.ser')
+      #
+      # @param path [Array<String>]
+      # @return [String]
+      def join *path
+        File.join(work_dir, *path)
+      end
+
+      # @param path [Array<String>]
+      # @return [Array<Solargraph::Pin::Base>, nil]
+      def load *path
+        file = join(*path)
+        return nil unless File.file?(file)
+        Marshal.load(File.read(file, mode: 'rb'))
+      rescue StandardError => e
+        Solargraph.logger.warn "Failed to load cached file #{file}: [#{e.class}] #{e.message}"
+        FileUtils.rm_f file
+        nil
+      end
+
+      def exist? *path
+        File.file? join(*path)
+      end
+
+      # @param path [Array<String>]
+      # @param pins [Array<Pin::Base>]
+      # @return [void]
+      def save *path, pins
+        file = File.join(work_dir, *path)
+        base = File.dirname(file)
+        FileUtils.mkdir_p base unless File.directory?(base)
+        ser = Marshal.dump(pins)
+        File.write file, ser, mode: 'wb'
+      end
+
+      # @return [void]
+      # @param path [Array<String>]
+      def uncache *path
+        FileUtils.rm_rf File.join(work_dir, *path), secure: true
+      end
+
+      # @return [void]
+      def clear
+        FileUtils.rm_rf base_dir, secure: true
+      end
+    end
+  end
+end