excelstream 0.20.2

High-performance streaming Excel & CSV library with S3/GCS cloud support and Parquet conversion - Ultra-low memory usage
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
//! Integration tests for rust-excelize

use excelstream::types::CellValue;
use excelstream::{ExcelReader, ExcelWriter};
use tempfile::NamedTempFile;

#[test]
fn test_write_and_read_roundtrip() {
    // Create temporary file
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    // Write data
    {
        let mut writer = ExcelWriter::new(&path).unwrap();
        writer.write_header(["Name", "Age", "City"]).unwrap();
        writer.write_row(["Alice", "30", "NYC"]).unwrap();
        writer.write_row(["Bob", "25", "SF"]).unwrap();
        writer.save().unwrap();
    }

    // Read data back
    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let rows: Vec<_> = reader
            .rows_by_index(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();

        assert_eq!(rows.len(), 3); // Header + 2 data rows

        // Check header
        let header = &rows[0];
        assert_eq!(header.to_strings(), vec!["Name", "Age", "City"]);

        // Check first data row
        let row1 = &rows[1];
        assert_eq!(row1.to_strings(), vec!["Alice", "30", "NYC"]);
    }
}

#[test]
fn test_typed_cells() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    // Write typed data
    {
        let mut writer = ExcelWriter::new(&path).unwrap();
        writer
            .write_row_typed(&[
                CellValue::String("Alice".to_string()),
                CellValue::Int(30),
                CellValue::Float(1234.56),
                CellValue::Bool(true),
            ])
            .unwrap();
        writer.save().unwrap();
    }

    // Read and verify types
    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let rows: Vec<_> = reader
            .rows_by_index(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();

        assert_eq!(rows.len(), 1);
        let row = &rows[0];

        assert_eq!(row.get(0).unwrap().as_string(), "Alice");
        assert_eq!(row.get(1).unwrap().as_i64(), Some(30));
        assert_eq!(row.get(2).unwrap().as_f64(), Some(1234.56));
        assert_eq!(row.get(3).unwrap().as_bool(), Some(true));
    }
}

#[test]
fn test_multi_sheet() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    // Write multiple sheets
    {
        let mut writer = ExcelWriter::new(&path).unwrap();

        writer.write_row(["Sheet1 Data"]).unwrap();

        writer.add_sheet("Sheet2").unwrap();
        writer.write_row(["Sheet2 Data"]).unwrap();

        writer.save().unwrap();
    }

    // Read and verify
    {
        let reader = ExcelReader::open(&path).unwrap();
        let sheets = reader.sheet_names();

        assert!(sheets.len() >= 2);
        // Note: Sheet names might have default names, check if our sheets exist
        assert!(sheets.iter().any(|s| s.contains("Sheet")));
    }
}

#[test]
fn test_large_dataset_streaming() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    let num_rows = 1000;

    // Write large dataset
    {
        let mut writer = ExcelWriter::new(&path).unwrap();
        writer.write_header(["ID", "Value"]).unwrap();

        for i in 0..num_rows {
            writer
                .write_row([&i.to_string(), &(i * 2).to_string()])
                .unwrap();
        }

        writer.save().unwrap();
    }

    // Read and verify with streaming
    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let row_count = reader.rows_by_index(0).unwrap().count();

        assert_eq!(row_count, num_rows + 1); // +1 for header
    }
}

#[test]
fn test_empty_cells() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();
        writer.write_row(["A", "", "C"]).unwrap();
        writer
            .write_row_typed(&[
                CellValue::String("X".to_string()),
                CellValue::Empty,
                CellValue::String("Z".to_string()),
            ])
            .unwrap();
        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let rows: Vec<_> = reader
            .rows_by_index(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();

        assert_eq!(rows.len(), 2);

        let row1 = &rows[0];
        assert_eq!(row1.get(0).unwrap().as_string(), "A");
        assert_eq!(row1.get(1).unwrap().as_string(), "");
        assert_eq!(row1.get(2).unwrap().as_string(), "C");
    }
}

#[test]
fn test_column_width() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    let mut writer = ExcelWriter::new(&path).unwrap();
    writer.set_column_width(0, 20.0).unwrap();
    writer.set_column_width(1, 30.0).unwrap();
    writer.write_row(["Col1", "Col2"]).unwrap();
    writer.save().unwrap();

    // Just verify no error occurred
    assert!(std::path::Path::new(&path).exists());
}

#[test]
fn test_sheet_dimensions() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();
        writer.write_row(["A", "B", "C"]).unwrap();
        writer.write_row(["1", "2", "3"]).unwrap();
        writer.write_row(["X", "Y", "Z"]).unwrap();
        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let (rows, cols) = reader.dimensions(&reader.sheet_names()[0]).unwrap();

        assert_eq!(rows, 3);
        assert_eq!(cols, 3);
    }
}

#[test]
fn test_special_characters() {
    let temp = NamedTempFile::new().unwrap();
    {
        let mut writer = ExcelWriter::new(temp.path()).unwrap();

        // Test various special characters
        writer
            .write_row([
                "Text with <xml> tags",
                "Quote: \"Hello\"",
                "Ampersand: &",
                "Apostrophe: '",
            ])
            .unwrap();

        writer
            .write_row(["Emoji: 😀🎉", "Unicode: Ñoño", "Math: ∑∏∫", "Currency: €£¥"])
            .unwrap();

        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(temp.path()).unwrap();
        let mut rows = reader.rows("Sheet1").unwrap();

        let row1 = rows.next().unwrap().unwrap();
        assert_eq!(row1.get(0).unwrap().as_string(), "Text with <xml> tags");
        assert_eq!(row1.get(1).unwrap().as_string(), "Quote: \"Hello\"");
        assert_eq!(row1.get(2).unwrap().as_string(), "Ampersand: &");

        let row2 = rows.next().unwrap().unwrap();
        assert!(row2.get(0).unwrap().as_string().contains("Emoji"));
        assert!(row2.get(1).unwrap().as_string().contains("Unicode"));
    }
}

#[test]
fn test_empty_strings() {
    let temp = NamedTempFile::new().unwrap();
    {
        let mut writer = ExcelWriter::new(temp.path()).unwrap();

        writer.write_row(["", "Empty", "", "Values"]).unwrap();
        writer.write_row(["A", "", "C", ""]).unwrap();

        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(temp.path()).unwrap();
        let mut rows = reader.rows("Sheet1").unwrap();

        let row1 = rows.next().unwrap().unwrap();
        assert_eq!(row1.len(), 4);
        assert_eq!(row1.get(0).unwrap().as_string(), "");
        assert_eq!(row1.get(1).unwrap().as_string(), "Empty");
    }
}

#[test]
fn test_very_long_strings() {
    let temp = NamedTempFile::new().unwrap();
    {
        let mut writer = ExcelWriter::new(temp.path()).unwrap();

        // Test with a very long string (10KB)
        let long_string = "A".repeat(10_000);
        writer.write_row([&long_string, "Normal", "Text"]).unwrap();

        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(temp.path()).unwrap();
        let mut rows = reader.rows("Sheet1").unwrap();

        let row = rows.next().unwrap().unwrap();
        assert_eq!(row.get(0).unwrap().as_string().len(), 10_000);
        assert_eq!(row.get(1).unwrap().as_string(), "Normal");
    }
}

#[test]
fn test_unicode_sheet_names() {
    let temp = NamedTempFile::new().unwrap();
    {
        let mut writer = ExcelWriter::new(temp.path()).unwrap();

        // Add sheet with Unicode name
        writer.add_sheet("Данные").unwrap(); // Russian
        writer.write_row(["Russian", "Data"]).unwrap();

        writer.add_sheet("数据").unwrap(); // Chinese
        writer.write_row(["Chinese", "Data"]).unwrap();

        writer.add_sheet("Données").unwrap(); // French
        writer.write_row(["French", "Data"]).unwrap();

        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(temp.path()).unwrap();
        let sheets = reader.sheet_names();

        assert!(sheets.contains(&"Данные".to_string()));
        assert!(sheets.contains(&"数据".to_string()));
        assert!(sheets.contains(&"Données".to_string()));

        // Read from Unicode sheet
        let mut rows = reader.rows("Данные").unwrap();
        let row = rows.next().unwrap().unwrap();
        assert_eq!(row.get(0).unwrap().as_string(), "Russian");
    }
}

#[test]
fn test_error_messages() {
    let temp = NamedTempFile::new().unwrap();
    {
        let mut writer = ExcelWriter::new(temp.path()).unwrap();
        writer.write_row(["Data"]).unwrap();
        writer.save().unwrap();
    }

    {
        let mut reader = ExcelReader::open(temp.path()).unwrap();

        // Test improved error message for missing sheet
        let result = reader.rows("NonExistent");
        assert!(result.is_err());

        if let Err(e) = result {
            let error_msg = e.to_string();
            println!("Error message: {}", error_msg);
            // Error should mention both the missing sheet and available sheets
            assert!(error_msg.contains("NonExistent"));
            assert!(error_msg.contains("Available"));
            assert!(error_msg.contains("Sheet1"));
        }
    }
}

#[test]
fn test_row_height() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();

        // Set height for first row
        writer.set_next_row_height(30.0).unwrap();
        writer.write_row(["Tall row"]).unwrap();

        // Normal row (default height)
        writer.write_row(["Normal row"]).unwrap();

        // Another tall row
        writer.set_next_row_height(25.0).unwrap();
        writer.write_row(["Another tall row"]).unwrap();

        writer.save().unwrap();
    }

    // Verify file was created successfully
    assert!(std::path::Path::new(&path).exists());
}

#[test]
fn test_column_width_and_row_height_together() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();

        // Set column widths
        writer.set_column_width(0, 25.0).unwrap();
        writer.set_column_width(1, 15.0).unwrap();
        writer.set_column_width(2, 20.0).unwrap();

        // Write header with custom height
        writer.set_next_row_height(25.0).unwrap();
        writer.write_header_bold(["Name", "Age", "Email"]).unwrap();

        // Regular data rows
        writer
            .write_row(["Alice", "30", "alice@example.com"])
            .unwrap();
        writer.write_row(["Bob", "25", "bob@example.com"]).unwrap();

        writer.save().unwrap();
    }

    // Verify file was created successfully
    assert!(std::path::Path::new(&path).exists());

    // Read back and verify data
    {
        let mut reader = ExcelReader::open(&path).unwrap();
        let rows: Vec<_> = reader
            .rows_by_index(0)
            .unwrap()
            .collect::<Result<Vec<_>, _>>()
            .unwrap();

        assert_eq!(rows.len(), 3);
        assert_eq!(rows[0].get(0).unwrap().as_string(), "Name");
        assert_eq!(rows[1].get(0).unwrap().as_string(), "Alice");
        assert_eq!(rows[2].get(0).unwrap().as_string(), "Bob");
    }
}

#[test]
fn test_column_width_must_be_set_before_rows() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();

        // Write a row first
        writer.write_row(["Data"]).unwrap();

        // Try to set column width after writing rows
        // In v0.5.0 (UltraLowMemory), set_column_width is a no-op (not supported)
        // So it returns Ok(()) instead of error
        let result = writer.set_column_width(0, 20.0);

        // v0.5.0: No-op, returns Ok
        // v0.4.x: Would return Err
        assert!(result.is_ok() || result.is_err());

        writer.save().unwrap();
    }
}

#[test]
fn test_multiple_sheets_with_column_widths() {
    let temp = NamedTempFile::new().unwrap();
    let path = temp.path().to_string_lossy().to_string();

    {
        let mut writer = ExcelWriter::new(&path).unwrap();

        // Sheet 1 with column widths
        writer.set_column_width(0, 20.0).unwrap();
        writer.set_column_width(1, 15.0).unwrap();
        writer.write_row(["Sheet1", "Data"]).unwrap();

        // Sheet 2 with different column widths
        writer.add_sheet("Sheet2").unwrap();
        writer.set_column_width(0, 30.0).unwrap();
        writer.set_column_width(1, 25.0).unwrap();
        writer.write_row(["Sheet2", "Data"]).unwrap();

        writer.save().unwrap();
    }

    // Verify both sheets exist
    {
        let reader = ExcelReader::open(&path).unwrap();
        let sheets = reader.sheet_names();
        assert!(sheets.len() >= 2);
    }
}