niblits 0.3.8

Token-aware, multi-format text chunking library with language-aware semantic splitting
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
mod chunker;
mod grammar_loader;
pub mod languages;

mod metadata_extractor;
mod types;

mod grammars;
mod walker;

use std::path::Path;
use std::pin::Pin;
use std::str::FromStr;
use std::sync::{
  Arc,
  atomic::{AtomicU64, Ordering},
};

use futures::{Stream, StreamExt};
use tokio::io::{AsyncRead, ReadBuf};

use crate::chunker::{get_chunker, get_chunker_with_overrides};
// Re-export main types
pub use crate::types::{
  Chunk, ChunkError, ChunkMetadata, FileMetadata, FileSymbols, OutlineUnit, ProjectChunk, SemanticChunk,
};
pub use crate::walker::{
  EntryFilter, WalkOptions, is_ignored_path, is_included_path, process_supported_files, process_text_files_only,
  walk_files, walk_project,
};
pub use chunker::ChunkerOverrides;

/// Tokenizer type for chunk size calculation
#[derive(Clone, serde::Serialize, serde::Deserialize)]
#[serde(tag = "type", rename_all = "lowercase")]
#[derive(Default)]
pub enum Tokenizer {
  /// Simple character-based tokenization
  #[serde(rename = "characters")]
  #[default]
  Characters,
  /// OpenAI tiktoken tokenizer with encoding name (e.g., "cl100k_base", "p50k_base")
  #[serde(rename = "tiktoken")]
  Tiktoken(#[serde(rename = "encoding")] String),
  /// Pre-loaded tiktoken tokenizer (internal use only, not exposed to bindings)
  #[doc(hidden)]
  #[serde(skip)]
  PreloadedTiktoken(std::sync::Arc<tiktoken_rs::CoreBPE>),
  /// HuggingFace tokenizer with specified model
  #[serde(rename = "huggingface")]
  HuggingFace(#[serde(rename = "model_id")] String),
  /// Pre-loaded HuggingFace tokenizer (internal use only, not exposed to bindings)
  #[doc(hidden)]
  #[serde(skip)]
  PreloadedHuggingFace(std::sync::Arc<tokenizers::Tokenizer>),
}

impl Tokenizer {
  /// Check if this tokenizer is preloaded
  pub fn is_preloaded(&self) -> bool {
    matches!(
      self,
      Tokenizer::PreloadedTiktoken(_) | Tokenizer::PreloadedHuggingFace(_)
    )
  }

  /// Count tokens for the provided text using this tokenizer.
  pub fn count_tokens(&self, text: &str) -> Result<usize, ChunkError> {
    match self {
      Tokenizer::Characters => Ok(text.chars().count()),
      Tokenizer::Tiktoken(encoding) => {
        let bpe = match encoding.as_str() {
          "cl100k_base" => tiktoken_rs::cl100k_base(),
          "p50k_base" => tiktoken_rs::p50k_base(),
          "p50k_edit" => tiktoken_rs::p50k_edit(),
          "r50k_base" => tiktoken_rs::r50k_base(),
          "o200k_base" => tiktoken_rs::o200k_base(),
          _ => {
            return Err(ChunkError::ParseError(format!(
              "Unknown tiktoken encoding: {}",
              encoding
            )));
          }
        };
        let bpe = bpe.map_err(|e| ChunkError::ParseError(format!("Failed to create tiktoken: {e}")))?;
        Ok(bpe.encode_ordinary(text).len())
      }
      Tokenizer::PreloadedTiktoken(bpe) => Ok(bpe.encode_ordinary(text).len()),
      Tokenizer::HuggingFace(model_id) => {
        let tokenizer = tokenizers::tokenizer::Tokenizer::from_pretrained(model_id, None)
          .map_err(|e| ChunkError::ParseError(format!("Failed to load HF tokenizer: {}", e)))?;
        tokenizer
          .encode(text, false)
          .map(|encoding| encoding.len())
          .map_err(|e| ChunkError::ParseError(format!("Failed to encode with HF tokenizer: {}", e)))
      }
      Tokenizer::PreloadedHuggingFace(tokenizer) => tokenizer
        .encode(text, false)
        .map(|encoding| encoding.len())
        .map_err(|e| ChunkError::ParseError(format!("Failed to encode with HF tokenizer: {}", e))),
    }
  }

  pub fn preload(self) -> Result<Self, ChunkError> {
    match self {
      Tokenizer::Tiktoken(encoding) => {
        let bpe = match encoding.as_str() {
          "cl100k_base" => tiktoken_rs::cl100k_base(),
          "p50k_base" => tiktoken_rs::p50k_base(),
          "p50k_edit" => tiktoken_rs::p50k_edit(),
          "r50k_base" => tiktoken_rs::r50k_base(),
          "o200k_base" => tiktoken_rs::o200k_base(),
          _ => {
            return Err(ChunkError::ParseError(format!(
              "Unknown tiktoken encoding: {}",
              encoding
            )));
          }
        };
        let bpe = bpe.map_err(|e| ChunkError::ParseError(format!("Failed to create tiktoken: {e}")))?;

        Ok(Tokenizer::PreloadedTiktoken(Arc::new(bpe)))
      }
      Tokenizer::HuggingFace(model_id) => {
        let tokenizer = tokenizers::tokenizer::Tokenizer::from_pretrained(&model_id, None)
          .map_err(|e| ChunkError::ParseError(format!("Failed to load HF tokenizer: {}", e)))?;
        Ok(Tokenizer::PreloadedHuggingFace(Arc::new(tokenizer)))
      }
      other => Ok(other),
    }
  }
}

impl std::fmt::Debug for Tokenizer {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    match self {
      Tokenizer::Characters => write!(f, "Characters"),
      Tokenizer::Tiktoken(name) => write!(f, "Tiktoken({})", name),
      Tokenizer::PreloadedTiktoken(_) => write!(f, "PreloadedTiktoken"),
      Tokenizer::HuggingFace(model) => write!(f, "HuggingFace({})", model),
      Tokenizer::PreloadedHuggingFace(_) => write!(f, "PreloadedHuggingFace"),
    }
  }
}

impl FromStr for Tokenizer {
  type Err = String;

  fn from_str(s: &str) -> Result<Self, Self::Err> {
    let lower = s.to_lowercase();
    match lower.as_str() {
      "characters" => Ok(Tokenizer::Characters),
      _ if lower.starts_with("tiktoken:") => {
        let encoding = s["tiktoken:".len()..].to_string().to_lowercase();
        Ok(Tokenizer::Tiktoken(encoding))
      }
      _ if lower.starts_with("hf:") => {
        let model_id = s["hf:".len()..].to_string();
        Ok(Tokenizer::HuggingFace(model_id))
      }
      _ if lower.starts_with("huggingface:") => {
        let model_id = s["huggingface:".len()..].to_string();
        Ok(Tokenizer::HuggingFace(model_id))
      }
      _ => Err(format!("Unknown tokenizer type: {}", s)),
    }
  }
}

/// Configuration for the chunker
#[derive(Clone, Debug)]
pub struct ChunkerConfig {
  /// Percentage of tokens to reserve for overlap between chunks
  pub overlap_percentage: f32,
  /// Maximum size of each chunk (in tokens/characters)
  pub max_chunk_size: usize,
  /// Tokenizer to use for size calculation
  pub tokenizer: Tokenizer,
}

impl Default for ChunkerConfig {
  fn default() -> Self {
    Self {
      overlap_percentage: 0.2,
      max_chunk_size: 1500,
      tokenizer: Tokenizer::default(),
    }
  }
}

/// Get list of supported programming languages
///
/// # Returns
/// A vector of language names that can be used with `chunk_code`
///
/// # Example
/// ```
/// let languages = niblits::supported_languages();
/// assert!(languages.contains(&"rust"));
/// ```
pub fn supported_languages() -> Vec<&'static str> {
  languages::supported_languages()
}

/// Check if a language is supported
///
/// # Arguments
/// * `name` - Language name to check (case-insensitive)
///
/// # Returns
/// `true` if the language is supported
///
/// # Example
/// ```
/// assert!(niblits::is_language_supported("rust"));
/// assert!(niblits::is_language_supported("Python")); // case-insensitive
/// ```
pub fn is_language_supported(name: &str) -> bool {
  languages::is_language_supported(name)
}

struct CountingReader<R> {
  inner: R,
  bytes_read: Arc<AtomicU64>,
}

impl<R> CountingReader<R> {
  fn new(inner: R) -> (Self, CountingReaderHandle) {
    let bytes_read = Arc::new(AtomicU64::new(0));
    let handle = CountingReaderHandle {
      bytes_read: Arc::clone(&bytes_read),
    };
    (Self { inner, bytes_read }, handle)
  }
}

impl<R: AsyncRead + Send + Unpin> AsyncRead for CountingReader<R> {
  fn poll_read(
    mut self: Pin<&mut Self>,
    cx: &mut std::task::Context<'_>,
    buf: &mut ReadBuf<'_>,
  ) -> std::task::Poll<std::io::Result<()>> {
    let before = buf.filled().len();
    let poll = Pin::new(&mut self.inner).poll_read(cx, buf);
    if let std::task::Poll::Ready(Ok(())) = &poll {
      let after = buf.filled().len();
      if after > before {
        self.bytes_read.fetch_add((after - before) as u64, Ordering::Relaxed);
      }
    }
    poll
  }
}

#[derive(Clone)]
struct CountingReaderHandle {
  bytes_read: Arc<AtomicU64>,
}

impl CountingReaderHandle {
  fn bytes_read(&self) -> u64 {
    self.bytes_read.load(Ordering::Relaxed)
  }
}

/// Process a single file-like stream and yield chunks as a stream
pub async fn chunk_stream<P, R>(
  path: P,
  reader: R,
  config: ChunkerConfig,
) -> impl Stream<Item = Result<ProjectChunk, ChunkError>> + Send
where
  P: AsRef<Path>,
  R: AsyncRead + Unpin + Send + 'static,
{
  let path = path.as_ref().to_owned();

  async_stream::try_stream! {
      let path_str = path.to_string_lossy().to_string();

      let (selected_chunker, file_reader) = get_chunker(&path, reader, config).await?;
      let (counting_reader, reader_stats) = CountingReader::new(file_reader);

      let mut chunk_stream = selected_chunker.chunk(&path, Box::new(counting_reader)).await;
      while let Some(chunk_result) = chunk_stream.next().await {
          let chunk = chunk_result?;
          let file_size = reader_stats.bytes_read();
          yield ProjectChunk {
              file_path: path_str.clone(),
              chunk,
              file_size,
          };
      }
  }
}

/// Process a single file-like stream and yield chunks as a stream, with overrides.
pub async fn chunk_stream_with_overrides<P, R>(
  path: P,
  reader: R,
  config: ChunkerConfig,
  overrides: ChunkerOverrides,
) -> impl Stream<Item = Result<ProjectChunk, ChunkError>> + Send
where
  P: AsRef<Path>,
  R: AsyncRead + Unpin + Send + 'static,
{
  let path = path.as_ref().to_owned();

  async_stream::try_stream! {
      let path_str = path.to_string_lossy().to_string();

      let (selected_chunker, file_reader) = get_chunker_with_overrides(&path, reader, config, overrides).await?;
      let (counting_reader, reader_stats) = CountingReader::new(file_reader);

      let mut chunk_stream = selected_chunker.chunk(&path, Box::new(counting_reader)).await;
      while let Some(chunk_result) = chunk_stream.next().await {
          let chunk = chunk_result?;
          let file_size = reader_stats.bytes_read();
          yield ProjectChunk {
              file_path: path_str.clone(),
              chunk,
              file_size,
          };
      }
  }
}

#[cfg(test)]
mod tests {
  use super::*;
  use futures::StreamExt;
  use std::io::Cursor;
  use std::path::Path;
  use std::str::FromStr;

  #[tokio::test]
  async fn test_process_file_semantic_rust() {
    let content = r#"fn main() {
    println!("Hello, world!");
}
"#;
    let path = Path::new("main.rs");
    let reader = Cursor::new(content.as_bytes().to_vec());
    let cfg = ChunkerConfig {
      max_chunk_size: 64,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: 0.0,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);

    let mut chunks = Vec::new();
    while let Some(item) = stream.next().await {
      chunks.push(item.expect("stream should yield Ok(ProjectChunk)"));
    }

    assert!(chunks.len() >= 2, "expect semantic chunks plus EOF");

    let file_size = content.len() as u64;

    // All content chunks should be Semantic
    let mut semantic_count = 0usize;
    for c in &chunks[..chunks.len() - 1] {
      assert_eq!(c.file_path, "main.rs");
      assert_eq!(c.file_size, file_size);
      match &c.chunk {
        Chunk::Semantic(sc) => {
          semantic_count += 1;
          assert!(!sc.text.is_empty());
        }
        other => panic!("expected semantic chunks, got {:?}", other),
      }
    }

    // Last should be EOF with expected_chunks == semantic_count
    match &chunks.last().unwrap().chunk {
      Chunk::EndOfFile {
        file_path,
        expected_chunks,
        ..
      } => {
        assert_eq!(file_path, "main.rs");
        assert_eq!(*expected_chunks, semantic_count);
      }
      other => panic!("expected EOF, got {:?}", other),
    }
  }

  #[tokio::test]
  async fn test_process_file_text_fallback() {
    let content = "lorem ipsum dolor sit amet, consectetur adipiscing elit.\n".repeat(10);
    let path = Path::new("notes.txt");
    let reader = Cursor::new(content.as_bytes().to_vec());
    let cfg = ChunkerConfig {
      max_chunk_size: 80,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: 0.0,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);

    let mut chunks = Vec::new();
    while let Some(item) = stream.next().await {
      chunks.push(item.expect("stream should yield Ok(ProjectChunk)"));
    }

    assert!(chunks.len() >= 2, "expect text chunks plus EOF");

    let file_size = content.len() as u64;

    let mut text_count = 0usize;
    for c in &chunks[..chunks.len() - 1] {
      assert_eq!(c.file_path, "notes.txt");
      assert_eq!(c.file_size, file_size);
      match &c.chunk {
        Chunk::Text(sc) => {
          text_count += 1;
          assert!(!sc.text.is_empty());
        }
        other => panic!("expected text chunks, got {:?}", other),
      }
    }

    match &chunks.last().unwrap().chunk {
      Chunk::EndOfFile {
        file_path,
        expected_chunks,
        ..
      } => {
        assert_eq!(file_path, "notes.txt");
        assert_eq!(*expected_chunks, text_count);
      }
      other => panic!("expected EOF, got {:?}", other),
    }
  }

  #[tokio::test]
  async fn test_process_pdf_file() {
    fn build_pdf(text: &str) -> Vec<u8> {
      let mut pdf = Vec::new();
      pdf.extend_from_slice(b"%PDF-1.4\n");

      let content_stream = format!("BT\n/F1 12 Tf\n36 720 Td\n({text}) Tj\nET\n");
      let objects = vec![
        "1 0 obj\n<< /Type /Catalog /Pages 2 0 R >>\nendobj\n".to_string(),
        "2 0 obj\n<< /Type /Pages /Kids [3 0 R] /Count 1 >>\nendobj\n".to_string(),
        "3 0 obj\n<< /Type /Page /Parent 2 0 R /MediaBox [0 0 612 792] /Contents 4 0 R /Resources << /Font << /F1 5 0 R >> >> >>\nendobj\n".to_string(),
        format!(
          "4 0 obj\n<< /Length {} >>\nstream\n{}endstream\nendobj\n",
          content_stream.len(),
          content_stream
        ),
        "5 0 obj\n<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>\nendobj\n".to_string(),
      ];

      let mut offsets = Vec::with_capacity(objects.len() + 1);
      offsets.push(0);

      for object in &objects {
        offsets.push(pdf.len());
        pdf.extend_from_slice(object.as_bytes());
      }

      let xref_position = pdf.len();
      let mut xref = format!("xref\n0 {}\n0000000000 65535 f \n", objects.len() + 1);
      for offset in offsets.iter().skip(1) {
        xref.push_str(&format!("{:010} 00000 n \n", offset));
      }
      pdf.extend_from_slice(xref.as_bytes());

      let trailer = format!(
        "trailer\n<< /Size {} /Root 1 0 R >>\nstartxref\n{}\n%%EOF\n",
        objects.len() + 1,
        xref_position
      );
      pdf.extend_from_slice(trailer.as_bytes());

      pdf
    }

    let content = "Hello from PDF";
    let data = build_pdf(content);
    let path = Path::new("document.pdf");
    let reader = Cursor::new(data);
    let cfg = ChunkerConfig {
      max_chunk_size: 200,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: 0.0,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);

    let mut saw_text_chunk = false;
    while let Some(item) = stream.next().await {
      let project_chunk = item.expect("stream should yield Ok(ProjectChunk)");
      if let Chunk::Text(sc) = &project_chunk.chunk {
        assert!(sc.text.contains(content));
        saw_text_chunk = true;
        break;
      }
    }

    assert!(saw_text_chunk, "expected to find a PDF text chunk");
  }

  #[tokio::test]
  async fn test_process_file_empty_input_yields_nothing() {
    let content = "";
    let path = Path::new("empty.txt");
    let reader = Cursor::new(content.as_bytes().to_vec());
    let cfg = ChunkerConfig {
      max_chunk_size: 80,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: 0.0,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);

    let mut count = 0usize;
    while let Some(_item) = stream.next().await {
      count += 1;
    }
    assert_eq!(count, 0, "empty input should produce no chunks");
  }

  #[test]
  fn test_tokenizer_from_str_case_insensitive_tiktoken_prefix() {
    let parsed = Tokenizer::from_str("TIKTOKEN:cl100k_base");
    assert!(
      parsed.is_ok(),
      "expected case-insensitive tiktoken prefix, got {:?}",
      parsed
    );
  }

  #[test]
  fn test_tokenizer_from_str_accepts_huggingface_prefix() {
    let parsed = Tokenizer::from_str("huggingface:bert-base-uncased");
    assert!(
      parsed.is_ok(),
      "expected huggingface: prefix alias to be accepted, got {:?}",
      parsed
    );
  }

  #[tokio::test]
  async fn test_negative_overlap_percentage_rejected() {
    let content = "short content";
    let path = Path::new("notes.txt");
    let reader = Cursor::new(content.as_bytes().to_vec());
    let cfg = ChunkerConfig {
      max_chunk_size: 16,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: -0.25,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);
    let first = stream.next().await.expect("stream should yield an item");
    assert!(
      first.is_err(),
      "expected negative overlap to be rejected, got {:?}",
      first
    );
  }

  #[tokio::test]
  async fn test_overlap_percentage_above_one_rejected() {
    let content = "short content";
    let path = Path::new("notes.txt");
    let reader = Cursor::new(content.as_bytes().to_vec());
    let cfg = ChunkerConfig {
      max_chunk_size: 16,
      tokenizer: Tokenizer::Characters,
      overlap_percentage: 1.5,
    };

    let mut stream = Box::pin(chunk_stream(path, reader, cfg).await);
    let first = stream.next().await.expect("stream should yield an item");
    assert!(first.is_err(), "expected overlap > 1.0 to be rejected, got {:?}", first);
  }
}