ruby-lsp 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fefb041d92fb2000d3da23248ed622abd596a95264b421349f27d104b85f997
-  data.tar.gz: 312918f128e0a49a2f5b2066354df2fe45f9ed37af5e5eace6c76caa101155e5
+  metadata.gz: 96c21e90970f4cbf198609a42471cf554ce86a3b6af9296ded95994ad373317a
+  data.tar.gz: a28aa2c13ba4d79f53082160b0eca7e8461efad831b6c6cca2a6a4d34765a6c0
 SHA512:
-  metadata.gz: 7ab96bd356fe94e3a95572bec24053eed9b467c71acec431a80c600e87ea5a3c31f0f2aee20c7b3b407b5aabc9b5736e0bb385dedf2840747c892fe7ad090b69
-  data.tar.gz: 2ec3f3c88c851e86e7ef6485c7719a271dbda81717990446900fe121844daac905b5f554833b59769a4c6f626bb50579d5e51970e7a306d206c898d0a289d36c
+  metadata.gz: 5ab1bf48ae4943a710f34ef0aace64c1d8991271bdca71482a2367c3a103299c52ebaef203fa32945236d689dda67d2bb1b5cc5ca9ffa698f5dd057dd62e242f
+  data.tar.gz: 8b9453d71b65634e1ea275f3a2552548f530dc144acd18cdcbcee493f153b824a13bc60bbbe5ac937a993d9e9c56ce8cb70773d354b5cea7acda3f4f44722ffd

data/CHANGELOG.md

@@ -6,6 +6,10 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.2.3]
+
+- Resolve generic source URIs for jump to gem source (https://github.com/Shopify/ruby-lsp/pull/237)
+
 ## [0.2.2]
 
 - Support document links (https://github.com/Shopify/ruby-lsp/pull/195)

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/ruby_lsp/requests/document_link.rb

@@ -1,30 +1,78 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "ruby_lsp/requests/support/source_uri"
+
 module RubyLsp
   module Requests
     # ![Document link demo](../../misc/document_link.gif)
     #
     # The [document link](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentLink)
-    # makes `# source://PATH_TO_FILE:line` comments in a Ruby/RBI file clickable if the file exists.
+    # makes `# source://PATH_TO_FILE#line` comments in a Ruby/RBI file clickable if the file exists.
     # When the user clicks the link, it'll open that location.
     #
     # # Example
     #
     # ```ruby
-    # # source://syntax_tree-3.2.1/lib/syntax_tree.rb:51 <- it will be clickable and will take the user to that location
+    # # source://syntax_tree/3.2.1/lib/syntax_tree.rb#51 <- it will be clickable and will take the user to that location
     # def format(source, maxwidth = T.unsafe(nil))
     # end
     # ```
     class DocumentLink < BaseRequest
       extend T::Sig
 
-      RUBY_ROOT = "RUBY_ROOT"
+      GEM_TO_VERSION_MAP = T.let(
+        [*::Gem::Specification.default_stubs, *::Gem::Specification.stubs].map! do |s|
+          [s.name, s.version.to_s]
+        end.to_h.freeze,
+        T::Hash[String, String]
+      )
+
+      class << self
+        extend T::Sig
+
+        sig { returns(T::Hash[String, T::Array[String]]) }
+        def gem_paths
+          @gem_paths ||= T.let(begin
+            lookup = {}
+
+            Gem::Specification.stubs.each do |stub|
+              spec = stub.to_spec
+              lookup[spec.name] = {}
+              lookup[spec.name][spec.version.to_s] = {}
+
+              Dir.glob("**/*.rb", base: "#{spec.full_gem_path}/").each do |path|
+                lookup[spec.name][spec.version.to_s][path] = "#{spec.full_gem_path}/#{path}"
+              end
+            end
 
-      sig { params(document: Document).void }
-      def initialize(document)
-        super
+            Gem::Specification.default_stubs.each do |stub|
+              spec = stub.to_spec
+              lookup[spec.name] = {}
+              lookup[spec.name][spec.version.to_s] = {}
+              prefix_matchers = [//]
+              prefix_matchers.concat(spec.require_paths.map { |rp| Regexp.new("^#{rp}/") })
+              prefix_matcher = Regexp.union(prefix_matchers)
+
+              spec.files.each do |file|
+                path = file.sub(prefix_matcher, "")
+                lookup[spec.name][spec.version.to_s][path] = "#{RbConfig::CONFIG["rubylibdir"]}/#{path}"
+              end
+            end
+
+            lookup
+          end, T.nilable(T::Hash[String, T::Array[String]]))
+        end
+      end
 
+      sig { params(uri: String, document: Document).void }
+      def initialize(uri, document)
+        super(document)
+
+        # Match the version based on the version in the RBI file name. Notice that the `@` symbol is sanitized to `%40`
+        # in the URI
+        version_match = /(?<=%40)[\d.]+(?=\.rbi$)/.match(uri)
+        @gem_version = T.let(version_match && version_match[0], T.nilable(String))
         @links = T.let([], T::Array[LanguageServer::Protocol::Interface::DocumentLink])
       end
 
@@ -36,24 +84,36 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::Comment).void }
       def visit_comment(node)
-        match = node.value.match(%r{source://(?<path>.*):(?<line>\d+)$})
+        match = node.value.match(%r{source://.*#\d+$})
         return unless match
 
-        file_path = if match[:path].start_with?(RUBY_ROOT)
-          match[:path].sub(RUBY_ROOT, RbConfig::CONFIG["rubylibdir"])
-        else
-          File.join(Bundler.bundle_path, "gems", match[:path])
-        end
-        return unless File.exist?(file_path)
-
-        target = "file://#{file_path}##{match[:line]}"
+        uri = T.cast(URI(match[0]), URI::Source)
+        gem_version = resolve_version(uri)
+        file_path = self.class.gem_paths.dig(uri.gem_name, gem_version, uri.path)
+        return if file_path.nil?
 
         @links << LanguageServer::Protocol::Interface::DocumentLink.new(
           range: range_from_syntax_tree_node(node),
-          target: target,
-          tooltip: "Jump to #{target.delete_prefix("file://")}"
+          target: "file://#{file_path}##{uri.line_number}",
+          tooltip: "Jump to #{file_path}##{uri.line_number}"
         )
       end
+
+      private
+
+      # Try to figure out the gem version for a source:// link. The order of precedence is:
+      # 1. The version in the URI
+      # 2. The version in the RBI file name
+      # 3. The version from the gemspec
+      sig { params(uri: URI::Source).returns(T.nilable(String)) }
+      def resolve_version(uri)
+        version = uri.gem_version
+        return version unless version.nil? || version.empty?
+
+        return @gem_version unless @gem_version.nil? || @gem_version.empty?
+
+        GEM_TO_VERSION_MAP[uri.gem_name]
+      end
     end
   end
 end

data/lib/ruby_lsp/requests/support/source_uri.rb

@@ -0,0 +1,82 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "uri/file"
+
+module URI
+  # Must be kept in sync with the one in Tapioca
+  class Source < URI::File
+    extend T::Sig
+
+    COMPONENT = T.let([
+      :scheme,
+      :gem_name,
+      :gem_version,
+      :path,
+      :line_number,
+    ].freeze, T::Array[Symbol])
+
+    T.unsafe(self).alias_method(:gem_name, :host)
+    T.unsafe(self).alias_method(:line_number, :fragment)
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :gem_version
+
+    class << self
+      extend T::Sig
+
+      sig do
+        params(
+          gem_name: String,
+          gem_version: T.nilable(String),
+          path: String,
+          line_number: T.nilable(String)
+        ).returns(URI::Source)
+      end
+      def build(gem_name:, gem_version:, path:, line_number:)
+        super(
+          {
+            scheme: "source",
+            host: gem_name,
+            path: DEFAULT_PARSER.escape("/#{gem_version}/#{path}"),
+            fragment: line_number,
+          }
+        )
+      end
+    end
+
+    sig { params(v: T.nilable(String)).void }
+    def set_path(v) # rubocop:disable Naming/AccessorMethodName
+      return if v.nil?
+
+      gem_version, path = v.delete_prefix("/").split("/", 2)
+
+      @gem_version = T.let(gem_version, T.nilable(String))
+      @path = T.let(path, T.nilable(String))
+    end
+
+    sig { params(v: T.nilable(String)).returns(T::Boolean) }
+    def check_host(v)
+      return true unless v
+
+      if /[A-Za-z][A-Za-z0-9\-_]*/ !~ v
+        raise InvalidComponentError,
+          "bad component(expected gem name): #{v}"
+      end
+
+      true
+    end
+
+    sig { returns(String) }
+    def to_s
+      "source://#{gem_name}/#{gem_version}#{path}##{line_number}"
+    end
+
+    if URI.respond_to?(:register_scheme)
+      URI.register_scheme("SOURCE", self)
+    else
+      @@schemes = T.let(@@schemes, T::Hash[String, Class]) # rubocop:disable Style/ClassVars
+      @@schemes["SOURCE"] = self
+    end
+  end
+end

data/lib/ruby_lsp/server.rb

@@ -98,8 +98,9 @@ module RubyLsp
     end
 
     on("textDocument/documentLink") do |request|
-      store.cache_fetch(request.dig(:params, :textDocument, :uri), :document_link) do |document|
-        RubyLsp::Requests::DocumentLink.new(document).run
+      uri = request.dig(:params, :textDocument, :uri)
+      store.cache_fetch(uri, :document_link) do |document|
+        RubyLsp::Requests::DocumentLink.new(uri, document).run
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -86,6 +86,7 @@ files:
 - lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb
 - lib/ruby_lsp/requests/support/selection_range.rb
 - lib/ruby_lsp/requests/support/semantic_token_encoder.rb
+- lib/ruby_lsp/requests/support/source_uri.rb
 - lib/ruby_lsp/requests/support/syntax_error_diagnostic.rb
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/store.rb