phpantom_lsp 0.7.0

Fast PHP language server with deep type intelligence. Generics, Laravel, PHPStan annotations. Ready in an instant.
Documentation
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
//! Integration tests: completion suppression inside string literals.
//!
//! Verifies that the LSP returns **no** completions when the cursor is
//! inside a plain string literal (single-quoted, nowdoc, or non-interpolation
//! positions in double-quoted strings), while still returning completions
//! inside PHP interpolation contexts (`{$expr->}`, `"$var->"`, heredocs
//! with interpolation).

use crate::common::create_test_backend;
use tower_lsp::LanguageServer;
use tower_lsp::lsp_types::*;

/// Helper: open a file and request completion at the given line/character.
/// Returns `None` when the server returns `Ok(None)` (i.e. no completions
/// at all), and `Some(items)` otherwise.
async fn complete_at_raw(
    backend: &phpantom_lsp::Backend,
    uri: &Url,
    text: &str,
    line: u32,
    character: u32,
) -> Option<Vec<CompletionItem>> {
    let open_params = DidOpenTextDocumentParams {
        text_document: TextDocumentItem {
            uri: uri.clone(),
            language_id: "php".to_string(),
            version: 1,
            text: text.to_string(),
        },
    };
    backend.did_open(open_params).await;

    let completion_params = CompletionParams {
        text_document_position: TextDocumentPositionParams {
            text_document: TextDocumentIdentifier { uri: uri.clone() },
            position: Position { line, character },
        },
        work_done_progress_params: WorkDoneProgressParams::default(),
        partial_result_params: PartialResultParams::default(),
        context: None,
    };

    match backend.completion(completion_params).await.unwrap() {
        Some(CompletionResponse::Array(items)) => Some(items),
        Some(CompletionResponse::List(list)) => Some(list.items),
        None => None,
    }
}

// ═══════════════════════════════════════════════════════════════════════════
//  Single-quoted strings — always suppress
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn no_completion_inside_single_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_single.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = 'hello ';\n",
    );

    // Cursor inside the single-quoted string (line 5, col 10: between 'hello' and closing ')
    let result = complete_at_raw(&backend, &uri, text, 5, 10).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside single-quoted string, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_completion_for_class_name_inside_single_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_single_class.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = 'Foo';\n",
    );

    // Cursor at 'Foo' inside the string — should NOT offer class completions
    let result = complete_at_raw(&backend, &uri, text, 4, 8).await;
    assert!(
        result.is_none(),
        "Should suppress class name completion inside single-quoted string, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_completion_for_dollar_inside_single_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_single_dollar.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = '$f->';\n",
    );

    // Cursor right after `->` inside the single-quoted string (no interpolation)
    let result = complete_at_raw(&backend, &uri, text, 5, 10).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside single-quoted string even with $f->, got: {:?}",
        result
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Double-quoted strings — suppress plain text, allow interpolation
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn no_completion_for_plain_text_in_double_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_plain.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello world\";\n",
    );

    // Cursor inside "hello world" at a plain text position
    let result = complete_at_raw(&backend, &uri, text, 5, 10).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside plain text in double-quoted string, got: {:?}",
        result
    );
}

#[tokio::test]
async fn completion_works_with_braces_in_double_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_brace.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public string $name = '';\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello {$f->}\";\n",
    );

    // Cursor after `$f->` inside `{$f->}` — line 6, col 18
    // "hello {$f->}" — positions: $ at 13, f at 14, - at 15, > at 16, } at 17, " at 18
    // We want cursor right after `->` which is col 17 (before })
    let result = complete_at_raw(&backend, &uri, text, 6, 17).await;
    assert!(
        result.is_some(),
        "Should allow completion inside {{$f->}} interpolation in double-quoted string"
    );
    let items = result.unwrap();
    let has_name = items.iter().any(|i| i.label == "name");
    assert!(
        has_name,
        "Should suggest 'name' property. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
    // Brace interpolation allows full expressions — methods should appear.
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Brace interpolation should include methods. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn completion_works_with_simple_interpolation_in_double_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_simple.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public string $name = '';\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello $f->\";\n",
    );

    // Cursor right after `$f->` (simple interpolation without braces)
    // Line 6: $s = "hello $f->"; — the -> ends at col 16
    let result = complete_at_raw(&backend, &uri, text, 6, 16).await;
    assert!(
        result.is_some(),
        "Should allow completion for simple interpolation $f-> in double-quoted string"
    );
    let items = result.unwrap();
    let has_name = items.iter().any(|i| i.label == "name");
    assert!(
        has_name,
        "Should suggest 'name' property. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
    // Simple interpolation only supports property access in PHP —
    // methods should be filtered out.
    let has_method = items
        .iter()
        .any(|i| i.kind == Some(CompletionItemKind::METHOD));
    assert!(
        !has_method,
        "Simple interpolation should NOT include methods. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn simple_interpolation_filters_methods_but_brace_does_not() {
    // Same class, same variable — verify that `"$f->"` shows only
    // properties while `"{$f->}"` shows both properties and methods.
    let backend = create_test_backend();

    let uri_simple = Url::parse("file:///str_filter_simple.php").unwrap();
    let text_simple = concat!(
        "<?php\n",
        "class Widget {\n",
        "    public string $title = '';\n",
        "    public int $count = 0;\n",
        "    public function render(): string { return ''; }\n",
        "    public function reset(): void {}\n",
        "}\n",
        "$w = new Widget();\n",
        "$s = \"val: $w->\";\n",
    );

    // Simple: $s = "val: $w->"
    // $=0 s=1 ' '=2 ==3 ' '=4 "=5 v=6 a=7 l=8 :=9 ' '=10 $=11 w=12 -=13 >=14 "=15
    let simple_items = complete_at_raw(&backend, &uri_simple, text_simple, 8, 15)
        .await
        .expect("Simple interpolation should return items");
    let simple_labels: Vec<&str> = simple_items.iter().map(|i| i.label.as_str()).collect();
    assert!(
        simple_labels.contains(&"title"),
        "Simple: should include 'title' property. Got: {:?}",
        simple_labels
    );
    assert!(
        simple_labels.contains(&"count"),
        "Simple: should include 'count' property. Got: {:?}",
        simple_labels
    );
    assert!(
        !simple_items
            .iter()
            .any(|i| i.kind == Some(CompletionItemKind::METHOD)),
        "Simple: should NOT include any methods. Got: {:?}",
        simple_labels
    );

    let uri_brace = Url::parse("file:///str_filter_brace.php").unwrap();
    let text_brace = concat!(
        "<?php\n",
        "class Widget {\n",
        "    public string $title = '';\n",
        "    public int $count = 0;\n",
        "    public function render(): string { return ''; }\n",
        "    public function reset(): void {}\n",
        "}\n",
        "$w = new Widget();\n",
        "$s = \"val: {$w->}\";\n",
    );

    // Brace: $s = "val: {$w->}"
    // $=0 s=1 ' '=2 ==3 ' '=4 "=5 v=6 a=7 l=8 :=9 ' '=10 {=11 $=12 w=13 -=14 >=15 }=16 "=17
    let brace_items = complete_at_raw(&backend, &uri_brace, text_brace, 8, 16)
        .await
        .expect("Brace interpolation should return items");
    let brace_labels: Vec<&str> = brace_items.iter().map(|i| i.label.as_str()).collect();
    assert!(
        brace_labels.contains(&"title"),
        "Brace: should include 'title' property. Got: {:?}",
        brace_labels
    );
    assert!(
        brace_items
            .iter()
            .any(|i| i.kind == Some(CompletionItemKind::METHOD)),
        "Brace: should include methods. Got: {:?}",
        brace_labels
    );
    assert!(
        brace_labels.iter().any(|l| l.starts_with("render")),
        "Brace: should include 'render' method. Got: {:?}",
        brace_labels
    );
}

#[tokio::test]
async fn completion_works_with_nullsafe_simple_interpolation() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_nullsafe.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public string $name = '';\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello $f?->\";\n",
    );

    // Cursor right after `$f?->` — line 6, col 17
    let result = complete_at_raw(&backend, &uri, text, 6, 17).await;
    assert!(
        result.is_some(),
        "Should allow completion for nullsafe interpolation $f?-> in double-quoted string"
    );
    let items = result.unwrap();
    let has_name = items.iter().any(|i| i.label == "name");
    assert!(
        has_name,
        "Should suggest 'name' property. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
    // Nullsafe simple interpolation is still simple — methods filtered.
    let has_method = items
        .iter()
        .any(|i| i.kind == Some(CompletionItemKind::METHOD));
    assert!(
        !has_method,
        "Nullsafe simple interpolation should NOT include methods. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Heredoc — suppress plain text, allow interpolation
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn no_completion_for_plain_text_in_heredoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_heredoc_plain.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = <<<EOT\n",
        "hello world\n",
        "EOT;\n",
    );

    // Cursor inside heredoc plain text (line 6, col 5)
    let result = complete_at_raw(&backend, &uri, text, 6, 5).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside plain text in heredoc, got: {:?}",
        result
    );
}

#[tokio::test]
async fn completion_works_with_braces_in_heredoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_heredoc_brace.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public string $name = '';\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = <<<EOT\n",
        "hello {$f->}\n",
        "EOT;\n",
    );

    // Cursor after `$f->` inside `{$f->}` — line 7, col 11
    // "hello {$f->}" — { at 6, $ at 7, f at 8, - at 9, > at 10, } at 11
    let result = complete_at_raw(&backend, &uri, text, 7, 11).await;
    assert!(
        result.is_some(),
        "Should allow completion inside {{$f->}} interpolation in heredoc"
    );
    let items = result.unwrap();
    let has_name = items.iter().any(|i| i.label == "name");
    assert!(
        has_name,
        "Should suggest 'name' property inside heredoc interpolation. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
    // Brace interpolation in heredoc should include methods too.
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Brace interpolation in heredoc should include methods. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn completion_works_with_simple_interpolation_in_heredoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_heredoc_simple.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public string $name = '';\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = <<<EOT\n",
        "hello $f->\n",
        "EOT;\n",
    );

    // Cursor right after `$f->` — line 7, col 10
    let result = complete_at_raw(&backend, &uri, text, 7, 10).await;
    assert!(
        result.is_some(),
        "Should allow completion for simple interpolation $f-> in heredoc"
    );
    let items = result.unwrap();
    let has_name = items.iter().any(|i| i.label == "name");
    assert!(
        has_name,
        "Should suggest 'name' property inside heredoc simple interpolation. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
    // Simple interpolation in heredoc — methods filtered.
    let has_method = items
        .iter()
        .any(|i| i.kind == Some(CompletionItemKind::METHOD));
    assert!(
        !has_method,
        "Simple interpolation in heredoc should NOT include methods. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Nowdoc — always suppress (no interpolation)
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn no_completion_inside_nowdoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_nowdoc.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = <<<'EOT'\n",
        "hello world\n",
        "EOT;\n",
    );

    // Cursor inside nowdoc (line 6, col 5)
    let result = complete_at_raw(&backend, &uri, text, 6, 5).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside nowdoc, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_completion_for_dollar_arrow_inside_nowdoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_nowdoc_arrow.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = <<<'EOT'\n",
        "$f->\n",
        "EOT;\n",
    );

    // Cursor after `$f->` inside nowdoc — no interpolation in nowdoc
    let result = complete_at_raw(&backend, &uri, text, 6, 4).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside nowdoc even with $f->, got: {:?}",
        result
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Normal code — still works after strings
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn completion_works_after_single_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_after_single.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = 'hello';\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    // Cursor after `$f->` in normal code — line 6, col 4
    let result = complete_at_raw(&backend, &uri, text, 6, 4).await;
    assert!(
        result.is_some(),
        "Should still offer completions in normal code after a string"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn completion_works_after_double_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_after_double.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = \"hello\";\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    let result = complete_at_raw(&backend, &uri, text, 6, 4).await;
    assert!(
        result.is_some(),
        "Should still offer completions in normal code after a double-quoted string"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn completion_works_after_heredoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_after_heredoc.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = <<<EOT\n",
        "hello\n",
        "EOT;\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    let result = complete_at_raw(&backend, &uri, text, 8, 4).await;
    assert!(
        result.is_some(),
        "Should still offer completions in normal code after a heredoc"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn completion_works_after_nowdoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_after_nowdoc.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = <<<'EOT'\n",
        "hello\n",
        "EOT;\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    let result = complete_at_raw(&backend, &uri, text, 8, 4).await;
    assert!(
        result.is_some(),
        "Should still offer completions in normal code after a nowdoc"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Edge cases
// ═══════════════════════════════════════════════════════════════════════════

#[tokio::test]
async fn variable_completion_inside_double_quoted_string_after_dollar_var() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_var_no_arrow.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello $f\";\n",
    );

    // Cursor right after `$f` — this is a valid interpolation site in a
    // double-quoted string (`"hello $f"` interpolates `$f`), so variable
    // completion should be allowed.
    // Line 5: $s = "hello $f";
    // $=0 s=1 ' '=2 ==3 ' '=4 "=5 h=6 e=7 l=8 l=9 o=10 ' '=11 $=12 f=13 "=14
    let result = complete_at_raw(&backend, &uri, text, 5, 14).await;
    assert!(
        result.is_some(),
        "Should allow completion for $var inside double-quoted string (interpolation site)"
    );
}

#[tokio::test]
async fn variable_completion_inside_double_quoted_string_bare_dollar() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_bare_dollar.php").unwrap();
    let text = concat!("<?php\n", "$foo = 42;\n", "$s = \"hello $\";\n",);

    // Cursor right after `$` — the user just typed a dollar sign to start
    // an interpolation. Variable name completion should fire.
    // Line 2: $s = "hello $";
    // $=0 s=1 ' '=2 ==3 ' '=4 "=5 h=6 e=7 l=8 l=9 o=10 ' '=11 $=12 "=13
    let result = complete_at_raw(&backend, &uri, text, 2, 13).await;
    assert!(
        result.is_some(),
        "Should allow variable completion for bare $ inside double-quoted string"
    );
    let items = result.unwrap();
    let has_foo = items.iter().any(|i| i.label == "$foo");
    assert!(
        has_foo,
        "Should suggest '$foo'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn variable_completion_inside_heredoc_bare_dollar() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_heredoc_bare_dollar.php").unwrap();
    let text = concat!(
        "<?php\n",
        "$foo = 42;\n",
        "$s = <<<EOT\n",
        "hello $\n",
        "EOT;\n",
    );

    // Cursor right after `$` inside heredoc — line 3, col 7
    let result = complete_at_raw(&backend, &uri, text, 3, 7).await;
    assert!(
        result.is_some(),
        "Should allow variable completion for bare $ inside heredoc"
    );
    let items = result.unwrap();
    let has_foo = items.iter().any(|i| i.label == "$foo");
    assert!(
        has_foo,
        "Should suggest '$foo' inside heredoc. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn no_variable_completion_for_dollar_inside_single_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_single_bare_dollar.php").unwrap();
    let text = concat!("<?php\n", "$foo = 42;\n", "$s = 'hello $';\n",);

    // Cursor right after `$` inside a single-quoted string — no
    // interpolation in single-quoted strings.
    let result = complete_at_raw(&backend, &uri, text, 2, 13).await;
    assert!(
        result.is_none(),
        "Should suppress variable completion for $ inside single-quoted string, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_variable_completion_for_dollar_inside_nowdoc() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_nowdoc_bare_dollar.php").unwrap();
    let text = concat!(
        "<?php\n",
        "$foo = 42;\n",
        "$s = <<<'EOT'\n",
        "hello $\n",
        "EOT;\n",
    );

    // Cursor right after `$` inside nowdoc — no interpolation in nowdoc.
    let result = complete_at_raw(&backend, &uri, text, 3, 7).await;
    assert!(
        result.is_none(),
        "Should suppress variable completion for $ inside nowdoc, got: {:?}",
        result
    );
}

#[tokio::test]
async fn escaped_quote_does_not_end_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_escaped_quote.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"she said \\\"hello\\\" ok\";\n",
    );

    // Cursor after the escaped quotes, still inside the string (col 22 is between "ok" and closing ")
    let result = complete_at_raw(&backend, &uri, text, 5, 22).await;
    assert!(
        result.is_none(),
        "Escaped quotes should not end the string early, got: {:?}",
        result
    );
}

#[tokio::test]
async fn escaped_single_quote_does_not_end_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_escaped_single.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = 'she said \\'hello\\' ok';\n",
    );

    // Cursor inside the string after escaped quotes
    let result = complete_at_raw(&backend, &uri, text, 5, 22).await;
    assert!(
        result.is_none(),
        "Escaped single quotes should not end the string early, got: {:?}",
        result
    );
}

#[tokio::test]
async fn comment_syntax_inside_string_still_suppressed() {
    // Existing behavior: comment-like text inside strings should not
    // confuse the scanner. This test ensures the string check and the
    // comment check work together.
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_comment_inside.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = '// not a comment';\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    // Cursor is in normal code after a string that contains `//`
    let result = complete_at_raw(&backend, &uri, text, 6, 4).await;
    assert!(
        result.is_some(),
        "Comment syntax inside a string should not suppress later completions"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should still suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

#[tokio::test]
async fn no_class_name_completion_inside_brace_interpolation() {
    // Even inside `{$...}` brace interpolation, class name / function
    // completions should not leak through — only member access and
    // variable name completions are useful there.
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_brace_no_class.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$s = \"hello {Foo}\";\n",
    );

    // Cursor at `Foo` inside braces but without `$` — not actually
    // an interpolation expression, so the brace is literal text.
    // This should be suppressed (it's string literal, not interpolation).
    let result = complete_at_raw(&backend, &uri, text, 5, 12).await;
    assert!(
        result.is_none(),
        "Should suppress class name completion inside non-interpolation braces, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_completion_for_non_interpolation_braces_in_double_quoted_string() {
    // `"{User::ADMIN_TYPE}"` is NOT interpolation because `{` is not
    // followed by `$`. PHP outputs the braces and text literally.
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_brace_no_dollar.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    const BAR = 1;\n",
        "}\n",
        "$s = \"{Foo::}\";\n",
    );

    // Cursor after `::` inside `{Foo::}` — col 11
    // $=0 s=1 ' '=2 ==3 ' '=4 "=5 {=6 F=7 o=8 o=9 :=10 :=11 }=12 "=13
    let result = complete_at_raw(&backend, &uri, text, 4, 12).await;
    assert!(
        result.is_none(),
        "Should suppress completion inside {{ClassName::}} without $ — not interpolation, got: {:?}",
        result
    );
}

#[tokio::test]
async fn no_class_name_completion_inside_double_quoted_string() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_double_class.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = \"Foo\";\n",
    );

    // Cursor at 'Foo' inside the double-quoted string
    let result = complete_at_raw(&backend, &uri, text, 4, 8).await;
    assert!(
        result.is_none(),
        "Should suppress class name completion inside double-quoted string, got: {:?}",
        result
    );
}

#[tokio::test]
async fn concatenation_after_string_works() {
    // `$f = 'x' . new Foo(); $f->` — make sure the scanner correctly
    // exits the string at the closing quote.
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_concat.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$s = 'hello';\n",
        "$f = new Foo();\n",
        "$f->\n",
    );

    let result = complete_at_raw(&backend, &uri, text, 6, 4).await;
    assert!(
        result.is_some(),
        "Code after a closed string should complete normally"
    );
}

#[test]
fn unit_classify_nested_braces_in_interpolation() {
    // Verify that array access brackets inside `{$arr['key']->}` do not
    // confuse the brace-depth tracker — the cursor after `->` should
    // still be classified as BraceInterpolation.
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$s = \"{$arr['key']->}\";\n";
    // Line 1: $=0 s=1 ' '=2 ==3 ' '=4 "=5 {=6 $=7 a=8 r=9 r=10
    //         [=11 '=12 k=13 e=14 y=15 '=16 ]=17 -=18 >=19 }=20 "=21
    // Cursor at col 20 (right after `>`, right before `}`)
    let pos = Position {
        line: 1,
        character: 20,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::BraceInterpolation
    );
}

#[tokio::test]
async fn multiple_strings_on_same_line() {
    let backend = create_test_backend();
    let uri = Url::parse("file:///str_multi_same_line.php").unwrap();
    let text = concat!(
        "<?php\n",
        "class Foo {\n",
        "    public function bar(): void {}\n",
        "}\n",
        "$f = new Foo();\n",
        "$a = 'x'; $b = 'y'; $f->\n",
    );

    // Cursor after `$f->` which is after two closed strings on the same line
    let result = complete_at_raw(&backend, &uri, text, 5, 25).await;
    assert!(
        result.is_some(),
        "Should complete after multiple closed strings on the same line"
    );
    let items = result.unwrap();
    let has_bar = items.iter().any(|i| i.label.starts_with("bar"));
    assert!(
        has_bar,
        "Should suggest 'bar'. Got: {:?}",
        items.iter().map(|i| &i.label).collect::<Vec<_>>()
    );
}

// ═══════════════════════════════════════════════════════════════════════════
//  Unit tests for classify_string_context
// ═══════════════════════════════════════════════════════════════════════════

#[test]
fn unit_classify_not_in_string() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = 1;\n";
    let pos = Position {
        line: 1,
        character: 5,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::NotInString
    );
}

#[test]
fn unit_classify_single_quoted() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = 'hello';\n";
    let pos = Position {
        line: 1,
        character: 8,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::InStringLiteral
    );
}

#[test]
fn unit_classify_double_quoted_plain() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = \"hello\";\n";
    let pos = Position {
        line: 1,
        character: 8,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::InStringLiteral
    );
}

#[test]
fn unit_classify_double_quoted_brace_interpolation() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    // Cursor inside {$f->} — after the ->
    let content = "<?php\n$x = \"{$f->}\";\n";
    // {=6 $=7 f=8 -=9 >=10 }=11 "=12
    let pos = Position {
        line: 1,
        character: 11,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::BraceInterpolation
    );
}

#[test]
fn unit_classify_double_quoted_simple_interpolation() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    // Cursor right after `$f->` (no braces)
    let content = "<?php\n$x = \"hi $f->\";\n";
    // h=6 i=7 ' '=8 $=9 f=10 -=11 >=12 "=13
    let pos = Position {
        line: 1,
        character: 13,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::SimpleInterpolation
    );
}

#[test]
fn unit_classify_double_quoted_bare_dollar() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    // Cursor right after bare `$` in a double-quoted string
    let content = "<?php\n$x = \"hi $\";\n";
    // h=6 i=7 ' '=8 $=9 "=10
    let pos = Position {
        line: 1,
        character: 10,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::SimpleInterpolation
    );
}

#[test]
fn unit_classify_double_quoted_partial_variable() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    // Cursor right after `$fo` (partially typed variable name)
    let content = "<?php\n$x = \"hi $fo\";\n";
    // h=6 i=7 ' '=8 $=9 f=10 o=11 "=12
    let pos = Position {
        line: 1,
        character: 12,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::SimpleInterpolation
    );
}

#[test]
fn unit_classify_nowdoc() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = <<<'EOT'\nhello\nEOT;\n";
    let pos = Position {
        line: 2,
        character: 3,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::InStringLiteral
    );
}

#[test]
fn unit_classify_heredoc_plain() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = <<<EOT\nhello\nEOT;\n";
    let pos = Position {
        line: 2,
        character: 3,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::InStringLiteral
    );
}

#[test]
fn unit_classify_heredoc_brace_interpolation() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = <<<EOT\n{$f->}\nEOT;\n";
    // Line 2: {=0 $=1 f=2 -=3 >=4 }=5
    let pos = Position {
        line: 2,
        character: 5,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::BraceInterpolation
    );
}

#[test]
fn unit_classify_after_string() {
    use phpantom_lsp::completion::comment_position::{StringContext, classify_string_context};
    let content = "<?php\n$x = 'hello'; $y = 1;\n";
    // Position after the string, in normal code
    let pos = Position {
        line: 1,
        character: 20,
    };
    assert_eq!(
        classify_string_context(content, pos),
        StringContext::NotInString
    );
}