solargraph 0.54.4 → 0.57.0

data/lib/solargraph/workspace/require_paths.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  # A workspace consists of the files in a project's directory and the
+  # project's configuration. It provides a Source for each file to be used
+  # in an associated Library or ApiMap.
+  #
+  class Workspace
+    # Manages determining which gemspecs are available in a workspace
+    class RequirePaths
+      attr_reader :directory, :config
+
+      # @param directory [String, nil]
+      # @param config [Config, nil]
+      def initialize directory, config
+        @directory = directory
+        @config = config
+      end
+
+      # Generate require paths from gemspecs if they exist or assume the default
+      # lib directory.
+      #
+      # @return [Array<String>]
+      def generate
+        result = require_paths_from_gemspec_files
+        return configured_require_paths if result.empty?
+        result.concat(config.require_paths.map { |p| File.join(directory, p) }) if config
+        result
+      end
+
+      private
+
+      # @return [Array<String>]
+      def require_paths_from_gemspec_files
+        results = []
+        gemspec_file_paths.each do |gemspec_file_path|
+          results.concat require_path_from_gemspec_file(gemspec_file_path)
+        end
+        results
+      end
+
+      # Get an array of all gemspec files in the workspace.
+      #
+      # @return [Array<String>]
+      def gemspec_file_paths
+        return [] if directory.nil?
+        @gemspec_file_paths ||= Dir[File.join(directory, '**/*.gemspec')].select do |gs|
+          config.nil? || config.allow?(gs)
+        end
+      end
+
+      # Get additional require paths defined in the configuration.
+      #
+      # @return [Array<String>]
+      def configured_require_paths
+        return ['lib'] unless directory
+        return [File.join(directory, 'lib')] if !config || config.require_paths.empty?
+        config.require_paths.map { |p| File.join(directory, p) }
+      end
+
+      # Generate require paths from gemspecs if they exist or assume the default
+      # lib directory.
+      #
+      # @param gemspec_file_path [String]
+      # @return [Array<String>]
+      def require_path_from_gemspec_file gemspec_file_path
+        base = File.dirname(gemspec_file_path)
+        # HACK: Evaluating gemspec files violates the goal of not running
+        #   workspace code, but this is how Gem::Specification.load does it
+        #   anyway.
+        cmd = ['ruby', '-e',
+               "require 'rubygems'; " \
+               "require 'json'; " \
+               "spec = eval(File.read('#{gemspec_file_path}'), TOPLEVEL_BINDING, '#{gemspec_file_path}'); " \
+               'return unless Gem::Specification === spec; ' \
+               'puts({name: spec.name, paths: spec.require_paths}.to_json)']
+        # @sg-ignore Unresolved call to capture3 on Module<Open3>
+        o, e, s = Open3.capture3(*cmd)
+        if s.success?
+          begin
+            hash = o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
+            return [] if hash.empty?
+            hash['paths'].map { |path| File.join(base, path) }
+          rescue StandardError => e
+            Solargraph.logger.warn "Error reading #{gemspec_file_path}: [#{e.class}] #{e.message}"
+            []
+          end
+        else
+          Solargraph.logger.warn "Error reading #{gemspec_file_path}"
+          Solargraph.logger.warn e
+          []
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/workspace.rb

@@ -10,15 +10,11 @@ module Solargraph
   #
   class Workspace
     autoload :Config, 'solargraph/workspace/config'
+    autoload :RequirePaths, 'solargraph/workspace/require_paths'
 
     # @return [String]
     attr_reader :directory
 
-    # The require paths associated with the workspace.
-    #
-    # @return [Array<String>]
-    attr_reader :require_paths
-
     # @return [Array<String>]
     attr_reader :gemnames
     alias source_gems gemnames
@@ -32,10 +28,17 @@ module Solargraph
       @server = server
       load_sources
       @gemnames = []
-      @require_paths = generate_require_paths
       require_plugins
     end
 
+    # The require paths associated with the workspace.
+    #
+    # @return [Array<String>]
+    def require_paths
+      # @todo are the semantics of '*' the same as '', meaning 'don't send back any require paths'?
+      @require_paths ||= RequirePaths.new(directory_or_nil, config).generate
+    end
+
     # @return [Solargraph::Workspace::Config]
     def config
       @config ||= Solargraph::Workspace::Config.new(directory)
@@ -106,7 +109,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 +136,16 @@ module Solargraph
       @gem_rbs_collection ||= read_rbs_collection_path
     end
 
+    # @return [String, nil]
+    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]
@@ -146,6 +159,20 @@ module Solargraph
       server['commandPath'] || 'solargraph'
     end
 
+    # @return [String, nil]
+    def directory_or_nil
+      return nil if directory.empty? || directory == '*'
+      directory
+    end
+
+    # True if the workspace has a root Gemfile.
+    #
+    # @todo Handle projects with custom Bundler/Gemfile setups (see DocMap#gemspecs_required_from_bundler)
+    #
+    def gemfile?
+      directory && File.file?(File.join(directory, 'Gemfile'))
+    end
+
     private
 
     # The language server configuration (or an empty hash if the workspace was
@@ -175,48 +202,6 @@ module Solargraph
       end
     end
 
-    # Generate require paths from gemspecs if they exist or assume the default
-    # lib directory.
-    #
-    # @return [Array<String>]
-    def generate_require_paths
-      return configured_require_paths unless gemspec?
-      result = []
-      gemspecs.each do |file|
-        base = File.dirname(file)
-        # HACK: Evaluating gemspec files violates the goal of not running
-        #   workspace code, but this is how Gem::Specification.load does it
-        #   anyway.
-        cmd = ['ruby', '-e', "require 'rubygems'; require 'json'; spec = eval(File.read('#{file}'), TOPLEVEL_BINDING, '#{file}'); return unless Gem::Specification === spec; puts({name: spec.name, paths: spec.require_paths}.to_json)"]
-        o, e, s = Open3.capture3(*cmd)
-        if s.success?
-          begin
-            hash = o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
-            next if hash.empty?
-            @gemnames.push hash['name']
-            result.concat(hash['paths'].map { |path| File.join(base, path) })
-          rescue StandardError => e
-            Solargraph.logger.warn "Error reading #{file}: [#{e.class}] #{e.message}"
-          end
-        else
-          Solargraph.logger.warn "Error reading #{file}"
-          Solargraph.logger.warn e
-        end
-      end
-      result.concat(config.require_paths.map { |p| File.join(directory, p) })
-      result.push File.join(directory, 'lib') if result.empty?
-      result
-    end
-
-    # Get additional require paths defined in the configuration.
-    #
-    # @return [Array<String>]
-    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)}
-    end
-
     # @return [void]
     def require_plugins
       config.plugins.each do |plugin|
@@ -230,10 +215,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/yard_map/helpers.rb

@@ -7,10 +7,38 @@ module Solargraph
       # @param spec [Gem::Specification, nil]
       # @return [Solargraph::Location, nil]
       def object_location code_object, spec
-        return nil if spec.nil? || code_object.nil? || code_object.file.nil? || code_object.line.nil?
+        if spec.nil? || code_object.nil? || code_object.file.nil? || code_object.line.nil?
+          if code_object.namespace.is_a?(YARD::CodeObjects::NamespaceObject)
+            # If the code object is a namespace, use the namespace's location
+            return object_location(code_object.namespace, spec)
+          end
+          return Solargraph::Location.new(__FILE__, Solargraph::Range.from_to(__LINE__ - 1, 0, __LINE__ - 1, 0))
+        end
         file = File.join(spec.full_gem_path, code_object.file)
         Solargraph::Location.new(file, Solargraph::Range.from_to(code_object.line - 1, 0, code_object.line - 1, 0))
       end
+
+      # @param code_object [YARD::CodeObjects::Base]
+      # @param spec [Gem::Specification, nil]
+      # @return [Solargraph::Pin::Namespace]
+      def create_closure_namespace_for(code_object, spec)
+        code_object_for_location = code_object
+        # code_object.namespace is sometimes a YARD proxy object pointing to a method path ("Object#new")
+        code_object_for_location = code_object.namespace if code_object.namespace.is_a?(YARD::CodeObjects::NamespaceObject)
+        namespace_location = object_location(code_object_for_location, spec)
+        ns_name = code_object.namespace.to_s
+        if ns_name.empty?
+          Solargraph::Pin::ROOT_PIN
+        else
+          Solargraph::Pin::Namespace.new(
+            name: ns_name,
+            closure: Pin::ROOT_PIN,
+            gates: [code_object.namespace.to_s],
+            source: :yardoc,
+            location: namespace_location
+          )
+        end
+      end
     end
   end
 end

data/lib/solargraph/yard_map/mapper/to_constant.rb

@@ -7,17 +7,19 @@ module Solargraph
         extend YardMap::Helpers
 
         # @param code_object [YARD::CodeObjects::Base]
+        # @param closure [Pin::Closure, nil]
+        # @param spec [Gem::Specification, nil]
+        # @return [Pin::Constant]
         def self.make code_object, closure = nil, spec = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
-          )
+          closure ||= create_closure_namespace_for(code_object, spec)
+
           Pin::Constant.new(
             location: object_location(code_object, spec),
             closure: closure,
             name: code_object.name.to_s,
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',
-            visibility: code_object.visibility
+            visibility: code_object.visibility,
+            source: :yardoc
           )
         end
       end

data/lib/solargraph/yard_map/mapper/to_method.rb

@@ -6,6 +6,11 @@ module Solargraph
       module ToMethod
         extend YardMap::Helpers
 
+        VISIBILITY_OVERRIDE = {
+          # YARD pays attention to 'private' statements prior to class methods but shouldn't
+          ["Rails::Engine", :class, "find_root_with_flag"] => :public
+        }
+
         # @param code_object [YARD::CodeObjects::Base]
         # @param name [String, nil]
         # @param scope [Symbol, nil]
@@ -14,31 +19,60 @@ module Solargraph
         # @param spec [Gem::Specification, nil]
         # @return [Solargraph::Pin::Method]
         def self.make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
-          )
+          closure ||= create_closure_namespace_for(code_object, spec)
           location = object_location(code_object, spec)
           name ||= code_object.name.to_s
           return_type = ComplexType::SELF if name == 'new'
           comments = code_object.docstring ? code_object.docstring.all.to_s : ''
-          pin = Pin::Method.new(
-            location: location,
-            closure: closure,
-            name: name,
-            comments: comments,
-            scope: scope || code_object.scope,
-            visibility: visibility || code_object.visibility,
-            # @todo Might need to convert overloads to signatures
-            parameters: [],
-            explicit: code_object.is_explicit?,
-            return_type: return_type
-          )
-          pin.parameters.concat get_parameters(code_object, location, comments, pin)
+          final_scope = scope || code_object.scope
+          override_key = [closure.path, final_scope, name]
+          final_visibility = VISIBILITY_OVERRIDE[override_key]
+          final_visibility ||= VISIBILITY_OVERRIDE[[closure.path, final_scope]]
+          final_visibility ||= :private if closure.path == 'Kernel' && Kernel.private_instance_methods(false).include?(name.to_sym)
+          final_visibility ||= visibility
+          final_visibility ||= :private if code_object.module_function? && final_scope == :instance
+          final_visibility ||= :public if code_object.module_function? && final_scope == :class
+          final_visibility ||= code_object.visibility
+          if code_object.is_alias?
+            origin_code_object = code_object.namespace.aliases[code_object]
+            pin = Pin::MethodAlias.new(
+              name: name,
+              location: location,
+              original: origin_code_object.name.to_s,
+              closure: closure,
+              comments: comments,
+              scope: final_scope,
+              visibility: final_visibility,
+              explicit: code_object.is_explicit?,
+              return_type: return_type,
+              parameters: [],
+              source: :yardoc,
+            )
+          else
+            pin = Pin::Method.new(
+              location: location,
+              closure: closure,
+              name: name,
+              comments: comments,
+              scope: final_scope,
+              visibility: final_visibility,
+              # @todo Might need to convert overloads to signatures
+              explicit: code_object.is_explicit?,
+              return_type: return_type,
+              attribute: code_object.is_attribute?,
+              parameters: [],
+              source: :yardoc,
+            )
+            pin.parameters.concat get_parameters(code_object, location, comments, pin)
+            pin.parameters.freeze
+          end
+          logger.debug { "ToMethod.make: Just created method pin: #{pin.inspect}" }
           pin
         end
 
         class << self
+          include Logging
+
           private
 
           # @param code_object [YARD::CodeObjects::Base]
@@ -59,7 +93,8 @@ module Solargraph
                 name: arg_name(a),
                 presence: nil,
                 decl: arg_type(a),
-                asgn_code: a[1]
+                asgn_code: a[1],
+                source: :yardoc,
               )
             end
           end

data/lib/solargraph/yard_map/mapper/to_namespace.rb

@@ -7,19 +7,21 @@ module Solargraph
         extend YardMap::Helpers
 
         # @param code_object [YARD::CodeObjects::NamespaceObject]
+        # @param spec [Gem::Specification, nil]
+        # @param closure [Pin::Closure, nil]
+        # @return [Pin::Namespace]
         def self.make code_object, spec, closure = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            closure: Pin::ROOT_PIN,
-            gates: [code_object.namespace.to_s]
-          )
+          closure ||= create_closure_namespace_for(code_object, spec)
+          location = object_location(code_object, spec)
+
           Pin::Namespace.new(
-            location: object_location(code_object, spec),
+            location: location,
             name: code_object.name.to_s,
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',
             type: code_object.is_a?(YARD::CodeObjects::ClassObject) ? :class : :module,
             visibility: code_object.visibility,
-            closure: closure
+            closure: closure,
+            source: :yardoc,
           )
         end
       end

data/lib/solargraph/yard_map/mapper.rb

@@ -47,15 +47,16 @@ module Solargraph
             else
               code_object.superclass.to_s
             end
-            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin)
+            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin, source: :yard_map)
           end
           code_object.class_mixins.each do |m|
-            result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path)
+            result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path, source: :yard_map)
           end
           code_object.instance_mixins.each do |m|
             result.push Solargraph::Pin::Reference::Include.new(
               closure: nspin, # @todo Fix this
-              name: m.path
+              name: m.path,
+              source: :yard_map
             )
           end
         elsif code_object.is_a?(YARD::CodeObjects::MethodObject)

data/lib/solargraph/yard_map/to_method.rb

@@ -23,7 +23,8 @@ module Solargraph
               name: arg_name(a),
               presence: nil,
               decl: arg_type(a),
-              asgn_code: a[1]
+              asgn_code: a[1],
+              source: :yard_map
             )
           end
         end
@@ -78,7 +79,8 @@ module Solargraph
           scope: scope || code_object.scope,
           visibility: visibility || code_object.visibility,
           parameters: InnerMethods.get_parameters(code_object, location, comments),
-          explicit: code_object.is_explicit?
+          explicit: code_object.is_explicit?,
+          source: :yard_map
         )
       end
     end

data/lib/solargraph/yardoc.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module Solargraph
   # Methods for caching and loading YARD documentation for gems.
   #
@@ -9,15 +11,25 @@ module Solargraph
     # Build and cache a gem's yardoc and return the path. If the cache already
     # exists, do nothing and return the path.
     #
+    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
     # @param gemspec [Gem::Specification]
     # @return [String] The path to the cached yardoc.
-    def cache(gemspec)
-      path = path_for(gemspec)
+    def cache(yard_plugins, gemspec)
+      path = PinCache.yardoc_path gemspec
       return path if cached?(gemspec)
 
       Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
-      Dir.chdir gemspec.gem_dir do
-        `yardoc --db #{path} --no-output --plugin solargraph`
+      cmd = "yardoc --db #{path} --no-output --plugin solargraph"
+      yard_plugins.each { |plugin| cmd << " --plugin #{plugin}" }
+      Solargraph.logger.debug { "Running: #{cmd}" }
+      # @todo set these up to run in parallel
+      #
+      # @sg-ignore RBS gem doesn't reflect that Open3.* also include
+      #   kwopts from Process.spawn()
+      stdout_and_stderr_str, status = Open3.capture2e(cmd, chdir: gemspec.gem_dir)
+      unless status.success?
+        Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{gemspec.gem_dir}" }
+        Solargraph.logger.info stdout_and_stderr_str
       end
       path
     end
@@ -26,16 +38,16 @@ 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.
+    # True if another process is currently building the yardoc cache.
     #
     # @param gemspec [Gem::Specification]
-    # @return [String]
-    def path_for(gemspec)
-      File.join(Solargraph::Cache.work_dir, 'gems', "#{gemspec.name}-#{gemspec.version}.yardoc")
+    def processing?(gemspec)
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'processing')
+      File.exist?(yardoc)
     end
 
     # Load a gem's yardoc and return its code objects.
@@ -45,7 +57,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

@@ -2,6 +2,7 @@
 
 Encoding.default_external = 'UTF-8'
 
+require 'bundler'
 require 'set'
 require 'yard-solargraph'
 require 'solargraph/yard_tags'
@@ -47,11 +48,34 @@ 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')
 
+  CHDIR_MUTEX = Mutex.new
+
+  # @param type [Symbol] Type of assert.
+  def self.asserts_on?(type)
+    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
+
+  # @param type [Symbol] The type of assertion to perform.
+  # @param msg [String, nil] An optional message to log
+  # @param block [Proc] A block that returns a message to log
+  # @return [void]
+  def self.assert_or_log(type, msg = nil, &block)
+    raise (msg || block.call) if asserts_on?(type) && ![:combine_with_visibility].include?(type)
+    logger.info msg, &block
+  end
+
   # A convenience method for Solargraph::Logging.logger.
   #
   # @return [Logger]
@@ -61,6 +85,11 @@ module Solargraph
 
   # A helper method that runs Bundler.with_unbundled_env or falls back to
   # Bundler.with_clean_env for earlier versions of Bundler.
+  #
+  # @generic T
+  # @yieldreturn [generic<T>]
+  # @sg-ignore dynamic call, but both functions behave the same
+  # @return [generic<T>]
   def self.with_clean_env &block
     meth = if Bundler.respond_to?(:with_original_env)
       :with_original_env
@@ -70,3 +99,7 @@ module Solargraph
     Bundler.send meth, &block
   end
 end
+
+# Ensure that ParserGem node processors are properly loaded to avoid conflicts
+# with Convention node processors
+require 'solargraph/parser/parser_gem/node_processors'