solargraph 0.46.0 → 0.54.5

data/lib/solargraph/diagnostics.rb

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # The Diagnostics library provides reporters for analyzing problems in code
-  # and providing the results to language server clients.
-  #
-  module Diagnostics
-    autoload :Base,            'solargraph/diagnostics/base'
-    autoload :Severities,      'solargraph/diagnostics/severities'
-    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
-    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
-    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
-    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
-    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
-
-    class << self
-      # Add a reporter with a name to identify it in .solargraph.yml files.
-      #
-      # @param name [String] The name
-      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
-      # @return [void]
-      def register name, klass
-        reporter_hash[name] = klass
-      end
-
-      # Get an array of reporter names.
-      #
-      # @return [Array<String>]
-      def reporters
-        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
-      end
-
-      # Find a reporter by name.
-      #
-      # @param name [String] The name with which the reporter was registered
-      # @return [Class<Solargraph::Diagnostics::Base>]
-      def reporter name
-        reporter_hash[name]
-      end
-
-      private
-
-      # @return [Hash]
-      def reporter_hash
-        @reporter_hash ||= {}
-      end
-    end
-
-    register 'rubocop', Rubocop
-    register 'require_not_found', RequireNotFound
-    register 'typecheck', TypeCheck
-    register 'update_errors', UpdateErrors
-    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # The Diagnostics library provides reporters for analyzing problems in code
+  # and providing the results to language server clients.
+  #
+  module Diagnostics
+    autoload :Base,            'solargraph/diagnostics/base'
+    autoload :Severities,      'solargraph/diagnostics/severities'
+    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
+    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
+    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
+    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
+    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
+
+    class << self
+      # Add a reporter with a name to identify it in .solargraph.yml files.
+      #
+      # @param name [String] The name
+      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
+      # @return [void]
+      def register name, klass
+        reporter_hash[name] = klass
+      end
+
+      # Get an array of reporter names.
+      #
+      # @return [Array<String>]
+      def reporters
+        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
+      end
+
+      # Find a reporter by name.
+      #
+      # @param name [String] The name with which the reporter was registered
+      # @return [Class<Solargraph::Diagnostics::Base>, nil]
+      def reporter name
+        reporter_hash[name]
+      end
+
+      private
+
+      # @return [Hash{String => Class<Solargraph::Diagnostics::Base>}]
+      def reporter_hash
+        @reporter_hash ||= {}
+      end
+    end
+
+    register 'rubocop', Rubocop
+    register 'require_not_found', RequireNotFound
+    register 'typecheck', TypeCheck
+    register 'update_errors', UpdateErrors
+    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
+  end
+end

data/lib/solargraph/doc_map.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Solargraph
+  # A collection of pins generated from required gems.
+  #
+  class DocMap
+    # @return [Array<String>]
+    attr_reader :requires
+
+    # @return [Array<Gem::Specification>]
+    attr_reader :preferences
+
+    # @return [Array<Pin::Base>]
+    attr_reader :pins
+
+    # @return [Array<Gem::Specification>]
+    attr_reader :uncached_gemspecs
+
+    # @param requires [Array<String>]
+    # @param preferences [Array<Gem::Specification>]
+    # @param rbs_path [String, Pathname, nil]
+    def initialize(requires, preferences, rbs_path = nil)
+      @requires = requires.compact
+      @preferences = preferences.compact
+      @rbs_path = rbs_path
+      generate
+    end
+
+    # @return [Array<Gem::Specification>]
+    def gemspecs
+      @gemspecs ||= required_gem_map.values.compact
+    end
+
+    # @return [Array<String>]
+    def unresolved_requires
+      @unresolved_requires ||= required_gem_map.select { |_, gemspec| gemspec.nil? }.keys
+    end
+
+    # @return [Hash{Gem::Specification => Array[Pin::Base]}]
+    def self.gems_in_memory
+      @gems_in_memory ||= {}
+    end
+
+    # @return [Set<Gem::Specification>]
+    def dependencies
+      @dependencies ||= (gemspecs.flat_map { |spec| fetch_dependencies(spec) } - gemspecs).to_set
+    end
+
+    private
+
+    # @return [void]
+    def generate
+      @pins = []
+      @uncached_gemspecs = []
+      required_gem_map.each do |path, gemspec|
+        if gemspec
+          try_cache gemspec
+        else
+          try_stdlib_map path
+        end
+      end
+      dependencies.each { |dep| try_cache dep }
+      @uncached_gemspecs.uniq!
+    end
+
+    # @return [Hash{String => Gem::Specification, nil}]
+    def required_gem_map
+      @required_gem_map ||= requires.to_h { |path| [path, resolve_path_to_gemspec(path)] }
+    end
+
+    # @return [Hash{String => Gem::Specification}]
+    def preference_map
+      @preference_map ||= preferences.to_h { |gemspec| [gemspec.name, gemspec] }
+    end
+
+    # @param gemspec [Gem::Specification]
+    # @return [void]
+    def try_cache gemspec
+      return if try_gem_in_memory(gemspec)
+      cache_file = File.join('gems', "#{gemspec.name}-#{gemspec.version}.ser")
+      if Cache.exist?(cache_file)
+        cached = Cache.load(cache_file)
+        gempins = update_from_collection(gemspec, cached)
+        self.class.gems_in_memory[gemspec] = gempins
+        @pins.concat gempins
+      else
+        Solargraph.logger.debug "No pin cache for #{gemspec.name} #{gemspec.version}"
+        @uncached_gemspecs.push gemspec
+      end
+    end
+
+    # @param path [String] require path that might be in the RBS stdlib collection
+    # @return [void]
+    def try_stdlib_map path
+      map = RbsMap::StdlibMap.load(path)
+      if map.resolved?
+        Solargraph.logger.debug "Loading stdlib pins for #{path}"
+        @pins.concat map.pins
+      else
+        # @todo Temporarily ignoring unresolved `require 'set'`
+        Solargraph.logger.debug "Require path #{path} could not be resolved" unless path == 'set'
+      end
+    end
+
+    # @param gemspec [Gem::Specification]
+    # @return [Boolean]
+    def try_gem_in_memory gemspec
+      gempins = DocMap.gems_in_memory[gemspec]
+      return false unless gempins
+      Solargraph.logger.debug "Found #{gemspec.name} #{gemspec.version} in memory"
+      @pins.concat gempins
+      true
+    end
+
+    # @param gemspec [Gem::Specification]
+    def update_from_collection gemspec, gempins
+      return gempins unless @rbs_path && File.directory?(@rbs_path)
+      return gempins if RbsMap.new(gemspec.name, gemspec.version).resolved?
+
+      rbs_map = RbsMap.new(gemspec.name, gemspec.version, directories: [@rbs_path])
+      return gempins unless rbs_map.resolved?
+
+      Solargraph.logger.info "Updating #{gemspec.name} #{gemspec.version} from collection"
+      GemPins.combine(gempins, rbs_map)
+    end
+
+    # @param path [String]
+    # @return [Gem::Specification, nil]
+    def resolve_path_to_gemspec path
+      return nil if path.empty?
+
+      gemspec = Gem::Specification.find_by_path(path)
+      if gemspec.nil?
+        gem_name_guess = path.split('/').first
+        begin
+          # this can happen when the gem is included via a local path in
+          # a Gemfile; Gem doesn't try to index the paths in that case.
+          #
+          # See if we can make a good guess:
+          potential_gemspec = Gem::Specification.find_by_name(gem_name_guess)
+          file = "lib/#{path}.rb"
+          gemspec = potential_gemspec if potential_gemspec.files.any? { |gemspec_file| file == gemspec_file }
+        rescue Gem::MissingSpecError
+          Solargraph.logger.debug "Require path #{path} could not be resolved to a gem via find_by_path or guess of #{gem_name_guess}"
+          nil
+        end
+      end
+      gemspec_or_preference gemspec
+    end
+
+    # @param gemspec [Gem::Specification, nil]
+    # @return [Gem::Specification, nil]
+    def gemspec_or_preference gemspec
+      return gemspec unless gemspec && preference_map.key?(gemspec.name)
+      return gemspec if gemspec.version == preference_map[gemspec.name].version
+
+      change_gemspec_version gemspec, preference_map[by_path.name].version
+    end
+
+    # @param gemspec [Gem::Specification]
+    # @param version [Gem::Version]
+    # @return [Gem::Specification]
+    def change_gemspec_version gemspec, version
+      Gem::Specification.find_by_name(gemspec.name, "= #{version}")
+    rescue Gem::MissingSpecError
+      Solargraph.logger.info "Gem #{gemspec.name} version #{version} not found. Using #{gemspec.version} instead"
+      gemspec
+    end
+
+    # @param gemspec [Gem::Specification]
+    # @return [Array<Gem::Specification>]
+    def fetch_dependencies gemspec
+      only_runtime_dependencies(gemspec).each_with_object(Set.new) do |spec, deps|
+        Solargraph.logger.info "Adding #{spec.name} dependency for #{gemspec.name}"
+        dep = Gem::Specification.find_by_name(spec.name, spec.requirement)
+        deps.merge fetch_dependencies(dep) if deps.add?(dep)
+      rescue Gem::MissingSpecError
+        Solargraph.logger.warn "Gem dependency #{spec.name} #{spec.requirements} for #{gemspec.name} not found."
+      end.to_a
+    end
+
+    # @param gemspec [Gem::Specification]
+    # @return [Array<Gem::Dependency>]
+    def only_runtime_dependencies gemspec
+      gemspec.dependencies - gemspec.development_dependencies
+    end
+  end
+end

data/lib/solargraph/environ.rb

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # A collection of additional data, such as map pins and required paths, that
-  # can be added to an ApiMap.
-  #
-  # Conventions are used to add Environs.
-  #
-  class Environ
-    # @return [Array<String>]
-    attr_reader :requires
-
-    # @return [Array<String>]
-    attr_reader :domains
-
-    # @return [Array<Pin::Reference::Override>]
-    attr_reader :pins
-
-    # @param requires [Array<String>]
-    # @param domains [Array<String>]
-    # @param pins [Array<Pin::Base>]
-    def initialize requires: [], domains: [], pins: []
-      @requires = requires
-      @domains = domains
-      @pins = pins
-    end
-
-    # @return [self]
-    def clear
-      domains.clear
-      requires.clear
-      pins.clear
-      self
-    end
-
-    # @param other [Environ]
-    # @return [self]
-    def merge other
-      domains.concat other.domains
-      requires.concat other.requires
-      pins.concat other.pins
-      self
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # A collection of additional data, such as map pins and required paths, that
+  # can be added to an ApiMap.
+  #
+  # Conventions are used to add Environs.
+  #
+  class Environ
+    # @return [Array<String>]
+    attr_reader :requires
+
+    # @return [Array<String>]
+    attr_reader :domains
+
+    # @return [Array<Pin::Reference::Override>]
+    attr_reader :pins
+
+    # @param requires [Array<String>]
+    # @param domains [Array<String>]
+    # @param pins [Array<Pin::Base>]
+    def initialize requires: [], domains: [], pins: []
+      @requires = requires
+      @domains = domains
+      @pins = pins
+    end
+
+    # @return [self]
+    def clear
+      domains.clear
+      requires.clear
+      pins.clear
+      self
+    end
+
+    # @param other [Environ]
+    # @return [self]
+    def merge other
+      domains.concat other.domains
+      requires.concat other.requires
+      pins.concat other.pins
+      self
+    end
+  end
+end

data/lib/solargraph/equality.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Solargraph
+  # @abstract This mixin relies on these -
+  #   methods:
+  #     equality_fields()
+  module Equality
+    # @!method equality_fields
+    #   @return [Array]
+
+    # @param other [Object]
+    # @return [Boolean]
+    def eql?(other)
+      self.class.eql?(other.class) &&
+        equality_fields.eql?(other.equality_fields)
+    end
+
+    # @param other [Object]
+    # @return [Boolean]
+    def ==(other)
+      self.eql?(other)
+    end
+
+    def hash
+      equality_fields.hash
+    end
+
+    def freeze
+      equality_fields.each(&:freeze)
+      super
+    end
+  end
+end

data/lib/solargraph/gem_pins.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+module Solargraph
+  # A utility for building gem pins from a combination of YARD and RBS
+  # documentation.
+  #
+  module GemPins
+    # Build an array of pins from a gem specification. The process starts with
+    # YARD, enhances the resulting pins with RBS definitions, and appends RBS
+    # pins that don't exist in the YARD mapping.
+    #
+    # @param gemspec [Gem::Specification]
+    # @return [Array<Pin::Base>]
+    def self.build(gemspec)
+      yard_pins = build_yard_pins(gemspec)
+      rbs_map = RbsMap.from_gemspec(gemspec)
+      combine yard_pins, rbs_map
+    end
+
+    # @param yard_pins [Array<Pin::Base>]
+    # @param rbs_map [RbsMap]
+    # @return [Array<Pin::Base>]
+    def self.combine(yard_pins, rbs_map)
+      in_yard = Set.new
+      combined = yard_pins.map do |yard|
+        in_yard.add yard.path
+        next yard unless yard.is_a?(Pin::Method)
+
+        rbs = rbs_map.path_pin(yard.path, Pin::Method)
+        next yard unless rbs
+
+        # @sg-ignore
+        yard.class.new(
+          location: yard.location,
+          closure: yard.closure,
+          name: yard.name,
+          comments: yard.comments,
+          scope: yard.scope,
+          parameters: rbs.parameters,
+          generics: rbs.generics,
+          node: yard.node,
+          signatures: yard.signatures,
+          return_type: best_return_type(rbs.return_type, yard.return_type)
+        )
+      end
+      in_rbs = rbs_map.pins.reject { |pin| in_yard.include?(pin.path) }
+      combined + in_rbs
+    end
+
+    class << self
+      private
+
+      # @param gemspec [Gem::Specification]
+      # @return [Array<Pin::Base>]
+      def build_yard_pins(gemspec)
+        Yardoc.cache(gemspec) unless Yardoc.cached?(gemspec)
+        yardoc = Yardoc.load!(gemspec)
+        YardMap::Mapper.new(yardoc, gemspec).map
+      end
+
+      # Select the first defined type.
+      #
+      # @param choices [Array<ComplexType>]
+      # @return [ComplexType]
+      def best_return_type *choices
+        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The CompletionItemKind constants for the language server protocol.
-    #
-    module CompletionItemKinds
-      TEXT = 1
-      METHOD = 2
-      FUNCTION = 3
-      CONSTRUCTOR = 4
-      FIELD = 5
-      VARIABLE = 6
-      CLASS = 7
-      INTERFACE = 8
-      MODULE = 9
-      PROPERTY = 10
-      UNIT = 11
-      VALUE = 12
-      ENUM = 13
-      KEYWORD = 14
-      SNIPPET = 15
-      COLOR = 16
-      FILE = 17
-      REFERENCE = 18
-      FOLDER = 19
-      ENUM_MEMBER = 20
-      CONSTANT = 21
-      STRUCT = 22
-      EVENT = 23
-      OPERATOR = 24
-      TYPE_PARAMETER = 25
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The CompletionItemKind constants for the language server protocol.
+    #
+    module CompletionItemKinds
+      TEXT = 1
+      METHOD = 2
+      FUNCTION = 3
+      CONSTRUCTOR = 4
+      FIELD = 5
+      VARIABLE = 6
+      CLASS = 7
+      INTERFACE = 8
+      MODULE = 9
+      PROPERTY = 10
+      UNIT = 11
+      VALUE = 12
+      ENUM = 13
+      KEYWORD = 14
+      SNIPPET = 15
+      COLOR = 16
+      FILE = 17
+      REFERENCE = 18
+      FOLDER = 19
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+  end
+end

data/lib/solargraph/language_server/error_codes.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The ErrorCode constants for the language server protocol.
-    #
-    module ErrorCodes
-      PARSE_ERROR =            -32700
-      INVALID_REQUEST =        -32600
-      METHOD_NOT_FOUND =       -32601
-      INVALID_PARAMS =         -32602
-      INTERNAL_ERROR =         -32603
-      SERVER_ERROR_START =     -32099
-      SERVER_ERROR_END =       -32000
-      SERVER_NOT_INITIALIZED = -32002
-      UNKNOWN_ERROR_CODE =     -32001
-      REQUEST_CANCELLED =      -32800
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The ErrorCode constants for the language server protocol.
+    #
+    module ErrorCodes
+      PARSE_ERROR =            -32700
+      INVALID_REQUEST =        -32600
+      METHOD_NOT_FOUND =       -32601
+      INVALID_PARAMS =         -32602
+      INTERNAL_ERROR =         -32603
+      SERVER_ERROR_START =     -32099
+      SERVER_ERROR_END =       -32000
+      SERVER_NOT_INITIALIZED = -32002
+      UNKNOWN_ERROR_CODE =     -32001
+      REQUEST_CANCELLED =      -32800
+    end
+  end
+end