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

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

#[test]
fn test_basic_method() {
    let source = r#"def greet(name)
  "Hello, #{name}!"
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

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

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

#[test]
fn test_method_with_rdoc() {
    let source = r#"# Calculates the sum of two numbers.
# @param a [Integer] First number
# @param b [Integer] Second number
# @return [Integer] Sum of a and b
def add(a, b)
  a + b
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

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

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

#[test]
fn test_class_definition() {
    let source = r#"class Calculator
  def initialize(value = 0)
    @value = value
  end

  def add(x)
    @value += x
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Class is extracted as a single chunk with methods inside
    let class_unit = get_unit_by_name(&units, "Calculator").unwrap();
    let class_text = build_embedding_text(class_unit);
    let expected_class = r#"Class: Calculator
Signature: class Calculator
File: test test.rb
Code:
class Calculator
  def initialize(value = 0)
    @value = value
  end

  def add(x)
    @value += x
  end
end"#;
    assert_eq!(class_text, expected_class);

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

#[test]
fn test_method_with_default_params() {
    let source = r#"def greet(name = "World", greeting = "Hello")
  greeting + ", " + name + "!"
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

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

    let expected = r#"Function: greet
Signature: def greet(name = "World", greeting = "Hello")
Parameters: name, greeting
File: test test.rb
Code:
def greet(name = "World", greeting = "Hello")
  greeting + ", " + name + "!"
end"#;
    assert_eq!(text, expected);
}

#[test]
fn test_method_with_keyword_params() {
    let source = r#"def create_user(name:, email:, age: nil)
  { name: name, email: email, age: age }
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

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

    let expected = r#"Function: create_user
Signature: def create_user(name:, email:, age: nil)
Parameters: name, email, age
File: test test.rb
Code:
def create_user(name:, email:, age: nil)
  { name: name, email: email, age: age }
end"#;
    assert_eq!(text, expected);
}

#[test]
fn test_module_definition() {
    let source = r#"module Utils
  def self.helper(x)
    x * 2
  end

  def instance_helper(x)
    x + 1
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Module is extracted as a single chunk with methods inside
    let module_unit = get_unit_by_name(&units, "Utils").unwrap();
    let module_text = build_embedding_text(module_unit);
    let expected_module = r#"Class: Utils
Signature: module Utils
File: test test.rb
Code:
module Utils
  def self.helper(x)
    x * 2
  end

  def instance_helper(x)
    x + 1
  end
end"#;
    assert_eq!(module_text, expected_module);

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

#[test]
fn test_method_with_block() {
    let source = r#"def with_logging
  puts "Starting..."
  result = yield
  puts "Done!"
  result
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

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

    let expected = r#"Function: with_logging
Signature: def with_logging
Calls: puts
Variables: result
File: test test.rb
Code:
def with_logging
  puts "Starting..."
  result = yield
  puts "Done!"
  result
end"#;
    assert_eq!(text, expected);
}

#[test]
fn test_class_method() {
    let source = r#"class Factory
  def self.create(type)
    case type
    when :widget then Widget.new
    when :gadget then Gadget.new
    end
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Class is extracted as a single chunk with class method inside
    let class_unit = get_unit_by_name(&units, "Factory").unwrap();
    let class_text = build_embedding_text(class_unit);
    let expected_class = r#"Class: Factory
Signature: class Factory
Calls: new
File: test test.rb
Code:
class Factory
  def self.create(type)
    case type
    when :widget then Widget.new
    when :gadget then Gadget.new
    end
  end
end"#;
    assert_eq!(class_text, expected_class);

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

#[test]
fn test_method_with_splat() {
    let source = r#"def sum(*numbers)
  numbers.reduce(0, :+)
end

def merge(**options)
  { default: true }.merge(options)
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    let sum_unit = get_unit_by_name(&units, "sum").unwrap();
    let sum_text = build_embedding_text(sum_unit);
    let expected_sum = r#"Function: sum
Signature: def sum(*numbers)
Parameters: numbers
Calls: reduce
File: test test.rb
Code:
def sum(*numbers)
  numbers.reduce(0, :+)
end"#;
    assert_eq!(sum_text, expected_sum);

    let merge_unit = get_unit_by_name(&units, "merge").unwrap();
    let merge_text = build_embedding_text(merge_unit);
    let expected_merge = r#"Function: merge
Signature: def merge(**options)
Parameters: options
Calls: merge
File: test test.rb
Code:
def merge(**options)
  { default: true }.merge(options)
end"#;
    assert_eq!(merge_text, expected_merge);
}

#[test]
fn test_attr_accessors() {
    let source = r#"class Person
  attr_reader :name
  attr_accessor :age

  def initialize(name, age)
    @name = name
    @age = age
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Class is extracted as a single chunk with attr accessors and method inside
    let class_unit = get_unit_by_name(&units, "Person").unwrap();
    let class_text = build_embedding_text(class_unit);
    let expected_class = r#"Class: Person
Signature: class Person
Calls: attr_accessor, attr_reader
File: test test.rb
Code:
class Person
  attr_reader :name
  attr_accessor :age

  def initialize(name, age)
    @name = name
    @age = age
  end
end"#;
    assert_eq!(class_text, expected_class);

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

#[test]
fn test_private_methods() {
    let source = r#"class Service
  def public_method
    helper
  end

  private

  def helper
    "secret"
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Class is extracted as a single chunk with all methods (public and private) inside
    let class_unit = get_unit_by_name(&units, "Service").unwrap();
    let class_text = build_embedding_text(class_unit);
    let expected_class = r#"Class: Service
Signature: class Service
File: test test.rb
Code:
class Service
  def public_method
    helper
  end

  private

  def helper
    "secret"
  end
end"#;
    assert_eq!(class_text, expected_class);

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

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

class Dog < Animal
  def speak
    "Woof!"
  end
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");

    // Animal class is extracted as a single chunk
    let animal = get_unit_by_name(&units, "Animal").unwrap();
    let animal_text = build_embedding_text(animal);
    let expected_animal = r#"Class: Animal
Signature: class Animal
File: test test.rb
Code:
class Animal
  def speak
    "..."
  end
end"#;
    assert_eq!(animal_text, expected_animal);
    // 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);
    let expected_dog = r#"Class: Dog
Signature: class Dog < Animal
Extends: Animal
File: test test.rb
Code:
class Dog < Animal
  def speak
    "Woof!"
  end
end"#;
    assert_eq!(dog_text, expected_dog);

    // 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#"require 'json'

def parse_data(str)
  JSON.parse(str)
end
"#;
    let units = parse(source, Language::Ruby, "test.rb");
    let func = get_unit_by_name(&units, "parse_data").unwrap();
    let text = build_embedding_text(func);

    let expected = r#"Function: parse_data
Signature: def parse_data(str)
Parameters: str
Calls: parse
Uses: json
File: test test.rb
Code:
def parse_data(str)
  JSON.parse(str)
end"#;
    assert_eq!(text, expected);
}