Class: RubyLsp::Listeners::DocumentLink

Inherits:
RubyLsp::Listener show all
Extended by:
T::Generic, T::Sig
Defined in:
lib/ruby_lsp/listeners/document_link.rb

Constant Summary collapse

ResponseType = 
type_member { { fixed: T::Array[Interface::DocumentLink] } }
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],
)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RubyLsp::Listener

#response

Methods included from Requests::Support::Common

#create_code_lens, #markdown_from_index_entries, #not_in_dependencies?, #range_from_location, #range_from_node, #self_receiver?, #visible?

Constructor Details

#initialize(uri, comments, dispatcher) ⇒ DocumentLink

Returns a new instance of DocumentLink.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 72

def initialize(uri, comments, dispatcher)
  super(dispatcher)

  # Match the version based on the version in the RBI file name. Notice that the `@` symbol is sanitized to `%40`
  # in the URI
  path = uri.to_standardized_path
  version_match = path ? /(?<=%40)[\d.]+(?=\.rbi$)/.match(path) : nil
  @gem_version = T.let(version_match && version_match[0], T.nilable(String))
  @_response = T.let([], T::Array[Interface::DocumentLink])
  @lines_to_comments = T.let(
    comments.to_h do |comment|
      [comment.location.end_line, comment]
    end,
    T::Hash[Integer, Prism::Comment],
  )

  dispatcher.register(
    self,
    :on_def_node_enter,
    :on_class_node_enter,
    :on_module_node_enter,
    :on_constant_write_node_enter,
    :on_constant_path_write_node_enter,
  )
end

Instance Attribute Details

#_response ⇒ Object (readonly)

Returns the value of attribute _response.



63
64
65
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 63

def _response
  @_response
end

Class Method Details

.gem_paths ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 25

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

      Gem::Specification.default_stubs.each do |stub|
        spec = stub.to_spec
        lookup[spec.name] = {}
        lookup[spec.name][spec.version.to_s] = {}
        prefix_matchers = Regexp.union(spec.require_paths.map do |rp|
                                         Regexp.new("^#{rp}/")
                                       end)
        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::Hash[String, T::Hash[String, String]]]),
  )
end

Instance Method Details

#on_class_node_enter(node) ⇒ Object 



104
105
106
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 104

def on_class_node_enter(node)
  extract_document_link(node)
end

#on_constant_path_write_node_enter(node) ⇒ Object 



119
120
121
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 119

def on_constant_path_write_node_enter(node)
  extract_document_link(node)
end

#on_constant_write_node_enter(node) ⇒ Object 



114
115
116
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 114

def on_constant_write_node_enter(node)
  extract_document_link(node)
end

#on_def_node_enter(node) ⇒ Object 



99
100
101
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 99

def on_def_node_enter(node)
  extract_document_link(node)
end

#on_module_node_enter(node) ⇒ Object 



109
110
111
 
# File 'lib/ruby_lsp/listeners/document_link.rb', line 109

def on_module_node_enter(node)
  extract_document_link(node)
end