colgrep 1.2.0

Semantic code search powered by ColBERT
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
//! Tests for PHP code extraction.

use super::common::*;
use crate::embed::build_embedding_text;
use crate::parser::Language;

#[test]
fn test_basic_function() {
    let source = r#"<?php
function greet($name) {
    return "Hello, " . $name . "!";
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "greet").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: greet
Signature: function greet($name) {
Parameters: $name
File: test test.php
Code:
function greet($name) {
    return \"Hello, \" . $name . \"!\";
}";

    assert_eq!(text, expected);
}

#[test]
fn test_function_with_phpdoc() {
    let source = r#"<?php
/**
 * Calculates the sum of two numbers.
 * @param int $a First number
 * @param int $b Second number
 * @return int Sum of a and b
 */
function add($a, $b) {
    return $a + $b;
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "add").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: add
Signature: function add($a, $b) {
Description: Calculates the sum of two numbers. @param int $a First number @param int $b Second number @return int Sum of a and b /
Parameters: $a, $b
File: test test.php
Code:
function add($a, $b) {
    return $a + $b;
}";

    assert_eq!(text, expected);
}

#[test]
fn test_class_definition() {
    let source = r#"<?php
class Person {
    private $name;
    private $age;

    public function __construct($name, $age) {
        $this->name = $name;
        $this->age = $age;
    }

    public function greet() {
        return "Hello, I'm " . $this->name;
    }
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Class is extracted as a single chunk with all methods inside
    let class = get_unit_by_name(&units, "Person").unwrap();
    let class_text = build_embedding_text(class);

    assert_eq!(
        class_text,
        "Class: Person
Signature: class Person {
File: test test.php
Code:
class Person {
    private $name;
    private $age;

    public function __construct($name, $age) {
        $this->name = $name;
        $this->age = $age;
    }

    public function greet() {
        return \"Hello, I'm \" . $this->name;
    }
}"
    );

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "greet").is_none(),
        "Methods should not be extracted separately from classes"
    );
    assert!(
        get_unit_by_name(&units, "__construct").is_none(),
        "Constructor should not be extracted separately from classes"
    );
}

#[test]
fn test_typed_function() {
    let source = r#"<?php
function add(int $a, int $b): int {
    return $a + $b;
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "add").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: add
Signature: function add(int $a, int $b): int {
Parameters: $a, $b
File: test test.php
Code:
function add(int $a, int $b): int {
    return $a + $b;
}";

    assert_eq!(text, expected);
}

#[test]
fn test_static_method() {
    let source = r#"<?php
class Utils {
    public static function helper(): string {
        return "help";
    }
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Class is extracted as a single chunk with static method inside
    let class = get_unit_by_name(&units, "Utils").unwrap();
    let class_text = build_embedding_text(class);

    assert_eq!(
        class_text,
        "Class: Utils
Signature: class Utils {
File: test test.php
Code:
class Utils {
    public static function helper(): string {
        return \"help\";
    }
}"
    );

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "helper").is_none(),
        "Methods should not be extracted separately from classes"
    );
}

#[test]
fn test_interface_definition() {
    let source = r#"<?php
interface Drawable {
    public function draw(): void;
    public function getBounds(): array;
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Interface is extracted as a single chunk with all method signatures inside
    let interface = get_unit_by_name(&units, "Drawable").unwrap();
    let text = build_embedding_text(interface);

    assert_eq!(
        text,
        "Class: Drawable
Signature: interface Drawable {
File: test test.php
Code:
interface Drawable {
    public function draw(): void;
    public function getBounds(): array;
}"
    );

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "draw").is_none(),
        "Interface methods should not be extracted separately"
    );
    assert!(
        get_unit_by_name(&units, "getBounds").is_none(),
        "Interface methods should not be extracted separately"
    );
}

#[test]
fn test_namespace_function() {
    let source = r#"<?php
namespace App\Utils;

function helper(): int {
    return 42;
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "helper").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: helper
Signature: function helper(): int {
File: test test.php
Code:
function helper(): int {
    return 42;
}";

    assert_eq!(text, expected);
}

#[test]
fn test_trait_definition() {
    let source = r#"<?php
trait Loggable {
    public function log(string $message): void {
        echo $message;
    }
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Trait is extracted as a single chunk with all methods inside
    let trait_unit = get_unit_by_name(&units, "Loggable").unwrap();
    let text = build_embedding_text(trait_unit);

    assert_eq!(
        text,
        "Class: Loggable
Signature: trait Loggable {
File: test test.php
Code:
trait Loggable {
    public function log(string $message): void {
        echo $message;
    }
}"
    );

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "log").is_none(),
        "Trait methods should not be extracted separately"
    );
}

#[test]
fn test_abstract_class() {
    let source = r#"<?php
abstract class Shape {
    abstract public function area(): float;

    public function describe(): string {
        return "I am a shape";
    }
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Abstract class is extracted as a single chunk with all methods inside
    let class = get_unit_by_name(&units, "Shape").unwrap();
    let class_text = build_embedding_text(class);

    assert_eq!(
        class_text,
        "Class: Shape
Signature: abstract class Shape {
File: test test.php
Code:
abstract class Shape {
    abstract public function area(): float;

    public function describe(): string {
        return \"I am a shape\";
    }
}"
    );

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "describe").is_none(),
        "Methods should not be extracted separately from classes"
    );
    assert!(
        get_unit_by_name(&units, "area").is_none(),
        "Abstract methods should not be extracted separately from classes"
    );
}

#[test]
fn test_anonymous_function() {
    let source = r#"<?php
function getMultiplier(int $factor): callable {
    return function(int $x) use ($factor): int {
        return $x * $factor;
    };
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "getMultiplier").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: getMultiplier
Signature: function getMultiplier(int $factor): callable {
Parameters: $factor
File: test test.php
Code:
function getMultiplier(int $factor): callable {
    return function(int $x) use ($factor): int {
        return $x * $factor;
    };
}";

    assert_eq!(text, expected);
}

#[test]
fn test_arrow_function() {
    let source = r#"<?php
$double = fn(int $x): int => $x * 2;

function process(array $items): array {
    return array_map(fn($x) => $x * 2, $items);
}
"#;
    let units = parse(source, Language::Php, "test.php");

    let func = get_unit_by_name(&units, "process").unwrap();
    let text = build_embedding_text(func);

    let expected = "Function: process
Signature: function process(array $items): array {
Parameters: $items
Calls: array_map
File: test test.php
Code:
function process(array $items): array {
    return array_map(fn($x) => $x * 2, $items);
}";

    assert_eq!(text, expected);
}

#[test]
fn test_class_inheritance() {
    let source = r#"<?php
class Animal {
    public function speak() {
        return "...";
    }
}

class Dog extends Animal {
    public function speak() {
        return "Woof!";
    }
}
"#;
    let units = parse(source, Language::Php, "test.php");

    // Animal class is extracted as a single chunk
    let animal = get_unit_by_name(&units, "Animal").unwrap();
    let animal_text = build_embedding_text(animal);
    assert_eq!(
        animal_text,
        r#"Class: Animal
Signature: class Animal {
File: test test.php
Code:
class Animal {
    public function speak() {
        return "...";
    }
}"#
    );
    // Animal has no parent
    assert!(!animal_text.contains("Extends:"));

    // Dog class is extracted as a single chunk with inheritance info
    let dog = get_unit_by_name(&units, "Dog").unwrap();
    let dog_text = build_embedding_text(dog);
    assert_eq!(
        dog_text,
        r#"Class: Dog
Signature: class Dog extends Animal {
Extends: Animal
File: test test.php
Code:
class Dog extends Animal {
    public function speak() {
        return "Woof!";
    }
}"#
    );

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "speak").is_none(),
        "Methods should not be extracted separately from classes"
    );
}

#[test]
fn test_function_with_imports() {
    let source = r#"<?php
use DateTime;

function getToday(): string {
    $dt = new DateTime();
    return $dt->format('Y-m-d');
}
"#;
    let units = parse(source, Language::Php, "test.php");
    let func = get_unit_by_name(&units, "getToday").unwrap();
    let text = build_embedding_text(func);

    // PHP Uses tracks imported classes used in object creation (new ClassName())
    let expected = r#"Function: getToday
Signature: function getToday(): string {
Uses: DateTime
File: test test.php
Code:
function getToday(): string {
    $dt = new DateTime();
    return $dt->format('Y-m-d');
}"#;
    assert_eq!(text, expected);
}