colgrep 1.3.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
//! Tests for Scala code extraction.

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

#[test]
fn test_basic_function() {
    let source = r#"def greet(name: String): String = {
  s"Hello, $name!"
}"#;
    let units = parse(source, Language::Scala, "test.scala");

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

    let expected = r#"Function: greet
Signature: def greet(name: String): String = {
Parameters: name
File: test test.scala
Code:
def greet(name: String): String = {
  s"Hello, $name!"
}"#;
    assert_eq!(text, expected);
}

#[test]
fn test_function_with_scaladoc() {
    let source = r#"/**
 * Calculates the sum of two numbers.
 * @param a First number
 * @param b Second number
 * @return Sum of a and b
 */
def add(a: Int, b: Int): Int = a + b"#;
    let units = parse(source, Language::Scala, "test.scala");

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

    let expected = "Function: add
Signature: def add(a: Int, b: Int): Int = a + b
Description: Calculates the sum of two numbers. @param a First number @param b Second number @return Sum of a and b /
Parameters: a, b
File: test test.scala
Code:
def add(a: Int, b: Int): Int = a + b";
    assert_eq!(text, expected);
}

#[test]
fn test_class_definition() {
    let source = r#"class Person(val name: String, var age: Int) {
  def greet(): String = s"Hello, I'm $name"
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // Class is extracted as a single chunk with method inside
    let class = get_unit_by_name(&units, "Person").unwrap();
    let text = build_embedding_text(class);
    assert_eq!(
        text,
        r#"Class: Person
Signature: class Person(val name: String, var age: Int) {
File: test test.scala
Code:
class Person(val name: String, var age: Int) {
  def greet(): String = s"Hello, I'm $name"
}"#
    );

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

#[test]
fn test_case_class() {
    let source = "case class User(id: Int, name: String, email: String)";
    let units = parse(source, Language::Scala, "test.scala");

    let class = get_unit_by_name(&units, "User").unwrap();
    let text = build_embedding_text(class);
    let expected = r#"Class: User
Signature: case class User(id: Int, name: String, email: String)
File: test test.scala
Code:
case class User(id: Int, name: String, email: String)"#;
    assert_eq!(text, expected);
}

#[test]
fn test_object_definition() {
    let source = r#"object Utils {
  def helper(x: Int): Int = x * 2

  val constant: String = "value"
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // Object is extracted as a single chunk with method inside
    let class = get_unit_by_name(&units, "Utils").unwrap();
    let text = build_embedding_text(class);
    assert_eq!(
        text,
        r#"Class: Utils
Signature: object Utils {
Variables: constant
File: test test.scala
Code:
object Utils {
  def helper(x: Int): Int = x * 2

  val constant: String = "value"
}"#
    );

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

#[test]
fn test_trait_definition() {
    let source = r#"trait Drawable {
  def draw(): Unit
  def bounds: Rectangle
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // Trait is extracted as a single chunk with all method signatures inside
    let class = get_unit_by_name(&units, "Drawable").unwrap();
    let text = build_embedding_text(class);
    assert_eq!(
        text,
        r#"Class: Drawable
Signature: trait Drawable {
File: test test.scala
Code:
trait Drawable {
  def draw(): Unit
  def bounds: Rectangle
}"#
    );

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

#[test]
fn test_function_with_generics() {
    let source = r#"def identity[T](value: T): T = value

def swap[A, B](pair: (A, B)): (B, A) = (pair._2, pair._1)"#;
    let units = parse(source, Language::Scala, "test.scala");

    let func = get_unit_by_name(&units, "identity").unwrap();
    let text = build_embedding_text(func);
    let expected = r#"Function: identity
Signature: def identity[T](value: T): T = value
Parameters: value
File: test test.scala
Code:
def identity[T](value: T): T = value"#;
    assert_eq!(text, expected);

    let func = get_unit_by_name(&units, "swap").unwrap();
    let text = build_embedding_text(func);
    let expected = r#"Function: swap
Signature: def swap[A, B](pair: (A, B)): (B, A) = (pair._2, pair._1)
Parameters: pair
File: test test.scala
Code:
def swap[A, B](pair: (A, B)): (B, A) = (pair._2, pair._1)"#;
    assert_eq!(text, expected);
}

#[test]
fn test_implicit_class() {
    let source = r#"implicit class StringOps(val s: String) extends AnyVal {
  def addExclamation: String = s + "!"
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // Implicit class is extracted as a single chunk with method inside
    let class = get_unit_by_name(&units, "StringOps").unwrap();
    let text = build_embedding_text(class);
    assert_eq!(
        text,
        r#"Class: StringOps
Signature: implicit class StringOps(val s: String) extends AnyVal {
Extends: AnyVal
File: test test.scala
Code:
implicit class StringOps(val s: String) extends AnyVal {
  def addExclamation: String = s + "!"
}"#
    );

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

#[test]
fn test_sealed_trait() {
    let source = r#"sealed trait Result[+T]
case class Success[T](value: T) extends Result[T]
case class Failure(message: String) extends Result[Nothing]"#;
    let units = parse(source, Language::Scala, "test.scala");

    let class = get_unit_by_name(&units, "Result").unwrap();
    let text = build_embedding_text(class);
    let expected = r#"Class: Result
Signature: sealed trait Result[+T]
Parameters: T
File: test test.scala
Code:
sealed trait Result[+T]"#;
    assert_eq!(text, expected);

    let class = get_unit_by_name(&units, "Success").unwrap();
    let text = build_embedding_text(class);
    let expected = r#"Class: Success
Signature: case class Success[T](value: T) extends Result[T]
Extends: Result
Parameters: T
File: test test.scala
Code:
case class Success[T](value: T) extends Result[T]"#;
    assert_eq!(text, expected);

    let class = get_unit_by_name(&units, "Failure").unwrap();
    let text = build_embedding_text(class);
    let expected = r#"Class: Failure
Signature: case class Failure(message: String) extends Result[Nothing]
Extends: Result
File: test test.scala
Code:
case class Failure(message: String) extends Result[Nothing]"#;
    assert_eq!(text, expected);
}

#[test]
fn test_companion_object() {
    let source = r#"class Circle(val radius: Double)

object Circle {
  def apply(radius: Double): Circle = new Circle(radius)
  def unit: Circle = new Circle(1.0)
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // There are two Circle units - the class and the companion object
    let circles: Vec<_> = units.iter().filter(|u| u.name == "Circle").collect();
    assert_eq!(circles.len(), 2);

    // Class is extracted as a single chunk
    let class = circles[0];
    let text = build_embedding_text(class);
    assert_eq!(
        text,
        r#"Class: Circle
Signature: class Circle(val radius: Double)
File: test test.scala
Code:
class Circle(val radius: Double)"#
    );

    // Companion object is extracted as a single chunk with methods inside
    let object = circles[1];
    let text = build_embedding_text(object);
    assert_eq!(
        text,
        r#"Class: Circle
Signature: object Circle {
File: test test.scala
Code:
object Circle {
  def apply(radius: Double): Circle = new Circle(radius)
  def unit: Circle = new Circle(1.0)
}"#
    );

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

#[test]
fn test_higher_order_function() {
    let source = r#"def map[A, B](list: List[A])(f: A => B): List[B] = {
  list.map(f)
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    let func = get_unit_by_name(&units, "map").unwrap();
    let text = build_embedding_text(func);
    let expected = r#"Function: map
Signature: def map[A, B](list: List[A])(f: A => B): List[B] = {
Parameters: list
Calls: map
File: test test.scala
Code:
def map[A, B](list: List[A])(f: A => B): List[B] = {
  list.map(f)
}"#;
    assert_eq!(text, expected);
}

#[test]
fn test_class_inheritance() {
    let source = r#"class Animal {
  def speak(): String = "..."
}

class Dog extends Animal {
  override def speak(): String = "Woof!"
}"#;
    let units = parse(source, Language::Scala, "test.scala");

    // Animal class is extracted as a single chunk with method inside
    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.scala
Code:
class Animal {
  def speak(): String = "..."
}"#
    );
    // 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.scala
Code:
class Dog extends Animal {
  override def speak(): String = "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#"import scala.collection.mutable.ArrayBuffer

def processBuffer(items: List[String]): ArrayBuffer[String] = {
  val buffer = ArrayBuffer.empty[String]
  items.foreach(item => buffer += item)
  buffer
}"#;
    let units = parse(source, Language::Scala, "test.scala");
    let func = get_unit_by_name(&units, "processBuffer").unwrap();
    let text = build_embedding_text(func);

    let expected = r#"Function: processBuffer
Signature: def processBuffer(items: List[String]): ArrayBuffer[String] = {
Parameters: items
Calls: foreach
Variables: buffer
Uses: ArrayBuffer
File: test test.scala
Code:
def processBuffer(items: List[String]): ArrayBuffer[String] = {
  val buffer = ArrayBuffer.empty[String]
  items.foreach(item => buffer += item)
  buffer
}"#;
    assert_eq!(text, expected);
}