colgrep 1.5.1

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
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
//! Tests for Java code extraction.

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

#[test]
fn test_basic_method() {
    let source = r#"public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
}"#;
    let units = parse(source, Language::Java, "Calculator.java");

    // Class should be extracted as a single chunk containing all methods
    // Methods are NOT extracted separately - they remain inside the class chunk
    let class_unit = get_unit_by_name(&units, "Calculator").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Calculator
Signature: public class Calculator {
File: calculator Calculator.java
Code:
public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "add").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_method_with_javadoc() {
    let source = r#"public class Math {
    /**
     * Calculates the sum of two numbers.
     * @param a First number
     * @param b Second number
     * @return Sum of a and b
     */
    public int add(int a, int b) {
        return a + b;
    }
}"#;
    let units = parse(source, Language::Java, "Math.java");

    // Class is extracted as a single chunk with javadoc and method inside
    let class_unit = get_unit_by_name(&units, "Math").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Math
Signature: public class Math {
File: math Math.java
Code:
public class Math {
    /**
     * Calculates the sum of two numbers.
     * @param a First number
     * @param b Second number
     * @return Sum of a and b
     */
    public int add(int a, int b) {
        return a + b;
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "add").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_static_method() {
    let source = r#"public class Utils {
    public static String format(String template, Object... args) {
        return String.format(template, args);
    }
}"#;
    let units = parse(source, Language::Java, "Utils.java");

    // Class is extracted as a single chunk with static method inside
    let class_unit = get_unit_by_name(&units, "Utils").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Utils
Signature: public class Utils {
Calls: format
Variables: args
File: utils Utils.java
Code:
public class Utils {
    public static String format(String template, Object... args) {
        return String.format(template, args);
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "format").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_method_with_generics() {
    let source = r#"public class Container<T> {
    private T value;

    public T getValue() {
        return value;
    }

    public void setValue(T value) {
        this.value = value;
    }
}"#;
    let units = parse(source, Language::Java, "Container.java");

    // Class is extracted as a single chunk with all methods inside
    let class_unit = get_unit_by_name(&units, "Container").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Container
Signature: public class Container<T> {
Parameters: T
Variables: value
File: container Container.java
Code:
public class Container<T> {
    private T value;

    public T getValue() {
        return value;
    }

    public void setValue(T value) {
        this.value = value;
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "getValue").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
    assert!(
        get_unit_by_name(&units, "setValue").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_constructor() {
    let source = r#"public class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
}"#;
    let units = parse(source, Language::Java, "Person.java");

    let class_unit = get_unit_by_name(&units, "Person").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Person
Signature: public class Person {
Variables: age, name
File: person Person.java
Code:
public class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
}"#;
    assert_eq!(class_text, class_expected);
}

#[test]
fn test_interface() {
    let source = r#"public interface Drawable {
    void draw();
    Rectangle getBounds();
}"#;
    let units = parse(source, Language::Java, "Drawable.java");

    let unit = get_unit_by_name(&units, "Drawable").unwrap();
    let text = build_embedding_text(unit);
    let expected = r#"Class: Drawable
Signature: public interface Drawable {
File: drawable Drawable.java
Code:
public interface Drawable {
    void draw();
    Rectangle getBounds();
}"#;
    assert_eq!(text, expected);
}

#[test]
fn test_method_throws() {
    let source = r#"public class FileReader {
    public String read(String path) throws IOException {
        return Files.readString(Path.of(path));
    }
}"#;
    let units = parse(source, Language::Java, "FileReader.java");

    // Class is extracted as a single chunk with method inside
    let class_unit = get_unit_by_name(&units, "FileReader").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: FileReader
Signature: public class FileReader {
Calls: of, readString
File: file reader FileReader.java
Code:
public class FileReader {
    public String read(String path) throws IOException {
        return Files.readString(Path.of(path));
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "read").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_enum() {
    let source = r#"public enum Status {
    ACTIVE("active"),
    INACTIVE("inactive"),
    PENDING("pending");

    private final String value;

    Status(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}"#;
    let units = parse(source, Language::Java, "Status.java");

    let unit = get_unit_by_name(&units, "Status").unwrap();
    let text = build_embedding_text(unit);
    let expected = r#"Class: Status
Signature: public enum Status {
Variables: value
File: status Status.java
Code:
public enum Status {
    ACTIVE("active"),
    INACTIVE("inactive"),
    PENDING("pending");

    private final String value;

    Status(String value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}"#;
    assert_eq!(text, expected);
}

#[test]
fn test_abstract_class() {
    let source = r#"public abstract class Shape {
    public abstract double area();

    public void describe() {
        System.out.println("I am a shape");
    }
}"#;
    let units = parse(source, Language::Java, "Shape.java");

    // Abstract class is extracted as a single chunk with all methods inside
    let class_unit = get_unit_by_name(&units, "Shape").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Shape
Signature: public abstract class Shape {
Calls: println
File: shape Shape.java
Code:
public abstract class Shape {
    public abstract double area();

    public void describe() {
        System.out.println("I am a shape");
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "describe").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
    assert!(
        get_unit_by_name(&units, "area").is_some(),
        "Abstract methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_annotations() {
    let source = r#"public class Service {
    @Override
    @Deprecated
    public String toString() {
        return "Service";
    }

    @PostConstruct
    public void init() {
        // Initialize
    }
}"#;
    let units = parse(source, Language::Java, "Service.java");

    // Class is extracted as a single chunk with annotated methods inside
    let class_unit = get_unit_by_name(&units, "Service").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: Service
Signature: public class Service {
File: service Service.java
Code:
public class Service {
    @Override
    @Deprecated
    public String toString() {
        return "Service";
    }

    @PostConstruct
    public void init() {
        // Initialize
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method units exist
    assert!(
        get_unit_by_name(&units, "toString").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
    assert!(
        get_unit_by_name(&units, "init").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_lambda_expression() {
    let source = r#"public class StreamExample {
    public List<String> filter(List<String> items) {
        return items.stream()
            .filter(s -> s.startsWith("a"))
            .collect(Collectors.toList());
    }
}"#;
    let units = parse(source, Language::Java, "StreamExample.java");

    // Class is extracted as a single chunk with lambda-containing method inside
    let class_unit = get_unit_by_name(&units, "StreamExample").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: StreamExample
Signature: public class StreamExample {
Calls: collect, filter, startsWith, stream, toList
File: stream example StreamExample.java
Code:
public class StreamExample {
    public List<String> filter(List<String> items) {
        return items.stream()
            .filter(s -> s.startsWith("a"))
            .collect(Collectors.toList());
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "filter").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}

#[test]
fn test_class_inheritance() {
    let source = r#"public class Animal {
    public void speak() {
        System.out.println("...");
    }
}

public class Dog extends Animal {
    @Override
    public void speak() {
        System.out.println("Woof!");
    }
}"#;
    let units = parse(source, Language::Java, "Animals.java");

    let animal = get_unit_by_name(&units, "Animal").unwrap();
    let animal_text = build_embedding_text(animal);
    // Animal has no parent
    assert!(!animal_text.contains("Extends:"));

    let dog = get_unit_by_name(&units, "Dog").unwrap();
    let dog_text = build_embedding_text(dog);
    let expected_dog = r#"Class: Dog
Signature: public class Dog extends Animal {
Extends: Animal
Calls: println
File: animals Animals.java
Code:
public class Dog extends Animal {
    @Override
    public void speak() {
        System.out.println("Woof!");
    }
}"#;
    assert_eq!(dog_text, expected_dog);
}

#[test]
fn test_function_with_imports() {
    let source = r#"import java.util.List;
import java.util.ArrayList;

public class ListUtils {
    public List<String> createList() {
        return new ArrayList<String>();
    }
}"#;
    let units = parse(source, Language::Java, "ListUtils.java");

    // Class is extracted as a single chunk with method inside
    let class_unit = get_unit_by_name(&units, "ListUtils").unwrap();
    let class_text = build_embedding_text(class_unit);
    let class_expected = r#"Class: ListUtils
Signature: public class ListUtils {
Calls: new
Uses: ArrayList
File: list utils ListUtils.java
Code:
public class ListUtils {
    public List<String> createList() {
        return new ArrayList<String>();
    }
}"#;
    assert_eq!(class_text, class_expected);

    // Verify NO separate method unit exists
    assert!(
        get_unit_by_name(&units, "createList").is_some(),
        "Methods are extracted as separate units alongside their parent classes"
    );
}