perl-lsp 0.2.4

A Perl LSP server built on tree-sitter-perl and tower-lsp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
60
61
62
63
64
65
66
67
68
69
70
71
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

-- E2E tests for framework intelligence: Moo/Moose accessors, roles,
-- Mojo::Base defaults, DBIC load_components, class :does.
--
-- Usage:
--   cargo build --release
--   PERL5LIB=$PWD/test_files/lib nvim --headless --clean -u test_nvim_init.lua -l test_e2e_frameworks.lua

vim.opt.rtp:prepend(".")

local t   = require("test.runner")
local lsp = require("test.lsp")
local b   = require("test.buf")

local buf = lsp.open_and_attach("test_files/frameworks.pl")

-- Wait for cross-file resolution (MyRole::Logging, DBIC Shortcut).
-- Poll by checking completion on $moo-> for "log_info" from the role.
local function wait_for_cross_file(max_secs)
  for _ = 1, max_secs * 4 do
    local line, col = b.find_pos(buf, '$moo->log_info("started")')
    if line then
      local labels = lsp.completion_labels(buf, line, col + 6)
      for _, l in ipairs(labels) do
        if l == "log_info" then return true end
      end
    end
    vim.wait(250)
  end
  return false
end

local cross_file_ready = wait_for_cross_file(15)
if not cross_file_ready then
  io.write("\27[33mWARN: cross-file resolution did not complete within 15s — some tests may fail\27[0m\n")
  io.write("      Make sure PERL5LIB includes test_files/lib\n\n")
end

-- ── 1. Moo accessor completion ───────────────────────────────────────

t.test("completion: $moo-> offers accessor 'name'", function()
  local N = "completion: $moo-> offers accessor 'name'"
  local line, col = b.find_pos(buf, "$moo->name();")
  if not t.ok(N, line, "couldn't find '$moo->name()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 6)
  if t.contains(N, labels, "name", "completions") then t.pass(N) end
end)

t.test("completion: $moo-> offers accessor 'count'", function()
  local N = "completion: $moo-> offers accessor 'count'"
  local line, col = b.find_pos(buf, "$moo->name();")
  if not t.ok(N, line, "couldn't find '$moo->name()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 6)
  if t.contains(N, labels, "count", "completions") then t.pass(N) end
end)

t.test("completion: $moo-> offers own method 'greet'", function()
  local N = "completion: $moo-> offers own method 'greet'"
  local line, col = b.find_pos(buf, "$moo->greet();")
  if not t.ok(N, line, "couldn't find '$moo->greet()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 6)
  if t.contains(N, labels, "greet", "completions") then t.pass(N) end
end)

-- ── 2. Moo role methods via `with` ──────────────────────────────────

t.test("completion: $moo-> offers log_info from MyRole::Logging", function()
  local N = "completion: $moo-> offers log_info from MyRole::Logging"
  local line, col = b.find_pos(buf, '$moo->log_info("started")')
  if not t.ok(N, line, "couldn't find '$moo->log_info()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 6)
  if t.contains(N, labels, "log_info", "completions") then t.pass(N) end
end)

t.test("completion: $moo-> offers log_error from MyRole::Logging", function()
  local N = "completion: $moo-> offers log_error from MyRole::Logging"
  local line, col = b.find_pos(buf, '$moo->log_info("started")')
  if not t.ok(N, line, "couldn't find '$moo->log_info()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 6)
  if t.contains(N, labels, "log_error", "completions") then t.pass(N) end
end)

t.test("hover: $moo->log_info() shows MyRole::Logging provenance", function()
  local N = "hover: $moo->log_info() shows MyRole::Logging provenance"
  local line, col = b.find_pos(buf, '$moo->log_info("started")')
  if not t.ok(N, line, "couldn't find '$moo->log_info()'") then return end
  local text = lsp.hover_text(buf, line, col + 6)
  if not t.ok(N, text, "no hover result") then return end
  if t.ok(N, text:find("Logging", 1, true),
    "hover should mention 'Logging', got: " .. text) then
    t.pass(N)
  end
end)

-- ── 3. Mojo::Base accessor completion ────────────────────────────────

t.test("completion: $mojo-> offers accessor 'title'", function()
  local N = "completion: $mojo-> offers accessor 'title'"
  local line, col = b.find_pos(buf, "$mojo->title();")
  if not t.ok(N, line, "couldn't find '$mojo->title()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 7)
  if t.contains(N, labels, "title", "completions") then t.pass(N) end
end)

t.test("completion: $mojo-> offers accessor 'items'", function()
  local N = "completion: $mojo-> offers accessor 'items'"
  local line, col = b.find_pos(buf, "$mojo->title();")
  if not t.ok(N, line, "couldn't find '$mojo->title()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 7)
  if t.contains(N, labels, "items", "completions") then t.pass(N) end
end)

-- ── 4. Mojo::Base default type inference ─────────────────────────────

t.test("hover: $mojo->title() mentions String (from default)", function()
  local N = "hover: $mojo->title() mentions String (from default)"
  local line, col = b.find_pos(buf, "$mojo->title();")
  if not t.ok(N, line, "couldn't find '$mojo->title()'") then return end
  local text = lsp.hover_text(buf, line, col + 7)
  if not t.ok(N, text, "no hover result") then return end
  if t.ok(N, text:find("String", 1, true),
    "hover should mention 'String', got: " .. text) then
    t.pass(N)
  end
end)

t.test("hover: $mojo->items() mentions ArrayRef (from sub default)", function()
  local N = "hover: $mojo->items() mentions ArrayRef (from sub default)"
  local line, col = b.find_pos(buf, "$mojo->items();")
  if not t.ok(N, line, "couldn't find '$mojo->items()'") then return end
  local text = lsp.hover_text(buf, line, col + 7)
  if not t.ok(N, text, "no hover result") then return end
  if t.ok(N, text:find("ArrayRef", 1, true),
    "hover should mention 'ArrayRef', got: " .. text) then
    t.pass(N)
  end
end)

-- ── 5. DBIC load_components ──────────────────────────────────────────

t.test("completion: $rs-> offers 'columns' from Shortcut component", function()
  local N = "completion: $rs-> offers 'columns' from Shortcut component"
  local line, col = b.find_pos(buf, "$rs->columns();")
  if not t.ok(N, line, "couldn't find '$rs->columns()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 5)
  if t.contains(N, labels, "columns", "completions") then t.pass(N) end
end)

t.test("completion: $rs-> offers 'order_by' from Shortcut component", function()
  local N = "completion: $rs-> offers 'order_by' from Shortcut component"
  local line, col = b.find_pos(buf, "$rs->columns();")
  if not t.ok(N, line, "couldn't find '$rs->columns()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 5)
  if t.contains(N, labels, "order_by", "completions") then t.pass(N) end
end)

t.test("completion: $rs-> offers own method 'active'", function()
  local N = "completion: $rs-> offers own method 'active'"
  local line, col = b.find_pos(buf, "$rs->active();")
  if not t.ok(N, line, "couldn't find '$rs->active()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 5)
  if t.contains(N, labels, "active", "completions") then t.pass(N) end
end)

-- ── 6. class :does ───────────────────────────────────────────────────

t.test("completion: $report-> offers 'generate' (own method)", function()
  local N = "completion: $report-> offers 'generate' (own method)"
  local line, col = b.find_pos(buf, "$report->generate();")
  if not t.ok(N, line, "couldn't find '$report->generate()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 9)
  if t.contains(N, labels, "generate", "completions") then t.pass(N) end
end)

t.test("completion: $report-> offers 'to_string' from :does(Printable)", function()
  local N = "completion: $report-> offers 'to_string' from :does(Printable)"
  local line, col = b.find_pos(buf, "$report->to_string();")
  if not t.ok(N, line, "couldn't find '$report->to_string()'") then return end
  local labels = lsp.completion_labels(buf, line, col + 9)
  if t.contains(N, labels, "to_string", "completions") then t.pass(N) end
end)

t.test("goto-def: $report->to_string() jumps to Printable::to_string", function()
  local N = "goto-def: $report->to_string() jumps to Printable::to_string"
  local line, col = b.find_pos(buf, "$report->to_string();")
  if not t.ok(N, line, "couldn't find '$report->to_string()'") then return end
  local def = lsp.def_line(buf, line, col + 9)
  local expected = b.find_line(buf, "method to_string")
  if t.eq(N, expected, def, "definition line") then t.pass(N) end
end)

-- ── 7. Dynamic method dispatch via constant folding ──────────────────

t.test("hover: $moo->$accessor() shows resolved accessor with POD", function()
  local N = "hover: $moo->$accessor() shows resolved accessor with POD"
  local line, col = b.find_pos(buf, "$moo->$accessor();")
  if not t.ok(N, line, "couldn't find '$moo->$accessor()'") then return end
  -- Cursor on $accessor — should show the resolved 'name' accessor info
  local text = lsp.hover_text(buf, line, col + 6)
  if not t.ok(N, text, "no hover result") then return end
  -- Should show the resolved method's POD, not just the variable
  if t.ok(N, text:find("display name", 1, true),
    "hover should show POD 'display name' from resolved accessor, got: " .. text) then
    t.pass(N)
  end
end)

t.test("hover: $dynamic_title from $mojo->$get_title() shows String", function()
  local N = "hover: $dynamic_title from $mojo->$get_title() shows String"
  local line, col = b.find_pos(buf, "$dynamic_title = $mojo->$get_title()")
  if not t.ok(N, line, "couldn't find dynamic_title line") then return end
  local text = lsp.hover_text(buf, line, col)
  if not t.ok(N, text, "no hover result") then return end
  if t.ok(N, text:find("String", 1, true),
    "hover should mention 'String' (from Mojo title default), got: " .. text) then
    t.pass(N)
  end
end)

-- ── 8. Moo constructor arg rename ────────────────────────────────────

t.test("rename: 'name' constructor arg produces edits at has + call site", function()
  local N = "rename: 'name' constructor arg produces edits at has + call site"
  -- Cursor on "name" in MooApp->new(name => 'alice', ...)
  local line, col = b.find_pos(buf, "MooApp->new(name =>")
  if not t.ok(N, line, "couldn't find constructor call") then return end

  -- Position on "name" key — col + 12 puts us on 'name' after 'MooApp->new('
  local edit = lsp.rename(buf, line, col + 12, "display_name")
  if not t.ok(N, edit, "rename returned no edit") then return end
  if not t.ok(N, edit.changes, "rename has no changes") then return end

  local total = 0
  for _, edits in pairs(edit.changes) do
    total = total + #edits
  end
  -- Should find at least: constructor arg (name =>) + has name definition = 2
  if t.ok(N, total >= 2, string.format("should have ≥2 edits (has def + constructor arg), got %d", total)) then
    t.pass(N)
  end
end)

-- ── 9. No unexpected diagnostics ─────────────────────────────────────

lsp.assert_no_diagnostics(t, buf)

-- ── done ─────────────────────────────────────────────────────────────

t.finish()