rustic-git 0.6.0

A Rustic Git - clean type-safe API over git cli
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
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
use crate::utils::git;
use crate::{Repository, Result};
use std::fmt;
use std::path::PathBuf;

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum IndexStatus {
    Clean,
    Modified,
    Added,
    Deleted,
    Renamed,
    Copied,
}

impl IndexStatus {
    /// Convert a git porcelain index character to IndexStatus
    pub const fn from_char(c: char) -> Self {
        match c {
            'M' => Self::Modified,
            'A' => Self::Added,
            'D' => Self::Deleted,
            'R' => Self::Renamed,
            'C' => Self::Copied,
            _ => Self::Clean,
        }
    }

    /// Convert IndexStatus to its git porcelain character representation
    pub const fn to_char(&self) -> char {
        match self {
            Self::Clean => ' ',
            Self::Modified => 'M',
            Self::Added => 'A',
            Self::Deleted => 'D',
            Self::Renamed => 'R',
            Self::Copied => 'C',
        }
    }
}

impl fmt::Display for IndexStatus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_char())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum WorktreeStatus {
    Clean,
    Modified,
    Deleted,
    Untracked,
    Ignored,
}

impl WorktreeStatus {
    /// Convert a git porcelain worktree character to WorktreeStatus
    pub const fn from_char(c: char) -> Self {
        match c {
            'M' => Self::Modified,
            'D' => Self::Deleted,
            '?' => Self::Untracked,
            '!' => Self::Ignored,
            _ => Self::Clean,
        }
    }

    /// Convert WorktreeStatus to its git porcelain character representation
    pub const fn to_char(&self) -> char {
        match self {
            Self::Clean => ' ',
            Self::Modified => 'M',
            Self::Deleted => 'D',
            Self::Untracked => '?',
            Self::Ignored => '!',
        }
    }
}

impl fmt::Display for WorktreeStatus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_char())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct FileEntry {
    pub path: PathBuf,
    pub index_status: IndexStatus,
    pub worktree_status: WorktreeStatus,
}

#[derive(Debug, Clone, PartialEq)]
pub struct GitStatus {
    pub entries: Box<[FileEntry]>,
}

impl GitStatus {
    pub fn is_clean(&self) -> bool {
        self.entries.is_empty()
    }

    pub fn has_changes(&self) -> bool {
        !self.is_clean()
    }

    // New API methods for staged/unstaged files
    /// Get all files that have changes in the index (staged)
    pub fn staged_files(&self) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(|entry| !matches!(entry.index_status, IndexStatus::Clean))
    }

    /// Get all files that have changes in the working tree (unstaged)
    pub fn unstaged_files(&self) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(|entry| !matches!(entry.worktree_status, WorktreeStatus::Clean))
    }

    /// Get all untracked files (new API)
    pub fn untracked_entries(&self) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(|entry| matches!(entry.worktree_status, WorktreeStatus::Untracked))
    }

    /// Get all ignored files
    pub fn ignored_files(&self) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(|entry| matches!(entry.worktree_status, WorktreeStatus::Ignored))
    }

    /// Get files with specific index status
    pub fn files_with_index_status(
        &self,
        status: IndexStatus,
    ) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(move |entry| entry.index_status == status)
    }

    /// Get files with specific worktree status  
    pub fn files_with_worktree_status(
        &self,
        status: WorktreeStatus,
    ) -> impl Iterator<Item = &FileEntry> + '_ {
        self.entries
            .iter()
            .filter(move |entry| entry.worktree_status == status)
    }

    /// Get all file entries
    pub fn entries(&self) -> &[FileEntry] {
        &self.entries
    }

    fn parse_porcelain_output(output: &str) -> Self {
        let mut entries = Vec::new();

        for line in output.lines() {
            if line.len() < 3 {
                continue;
            }

            let index_char = line.chars().nth(0).unwrap_or(' ');
            let worktree_char = line.chars().nth(1).unwrap_or(' ');
            let filename = line[3..].to_string();
            let path = PathBuf::from(&filename);

            let index_status = IndexStatus::from_char(index_char);
            let worktree_status = WorktreeStatus::from_char(worktree_char);

            // Skip entries that are completely clean
            if matches!(index_status, IndexStatus::Clean)
                && matches!(worktree_status, WorktreeStatus::Clean)
            {
                continue;
            }

            let entry = FileEntry {
                path,
                index_status,
                worktree_status,
            };

            entries.push(entry);
        }

        Self {
            entries: entries.into_boxed_slice(),
        }
    }
}

impl Repository {
    /// Get the status of the repository.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `GitStatus` or a `GitError`.
    pub fn status(&self) -> Result<GitStatus> {
        Self::ensure_git()?;

        let stdout = git(&["status", "--porcelain"], Some(self.repo_path()))?;
        Ok(GitStatus::parse_porcelain_output(&stdout))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::env;
    use std::fs;

    #[test]
    fn test_parse_porcelain_output() {
        let output = "M  modified.txt\nA  added.txt\nD  deleted.txt\n?? untracked.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 4);

        // Find entries by path for testing
        let modified_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("modified.txt"))
            .unwrap();
        assert_eq!(modified_entry.index_status, IndexStatus::Modified);
        assert_eq!(modified_entry.worktree_status, WorktreeStatus::Clean);

        let added_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("added.txt"))
            .unwrap();
        assert_eq!(added_entry.index_status, IndexStatus::Added);
        assert_eq!(added_entry.worktree_status, WorktreeStatus::Clean);

        let deleted_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("deleted.txt"))
            .unwrap();
        assert_eq!(deleted_entry.index_status, IndexStatus::Deleted);
        assert_eq!(deleted_entry.worktree_status, WorktreeStatus::Clean);

        let untracked_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("untracked.txt"))
            .unwrap();
        assert_eq!(untracked_entry.index_status, IndexStatus::Clean);
        assert_eq!(untracked_entry.worktree_status, WorktreeStatus::Untracked);

        // Test new API methods
        let staged_files: Vec<_> = status.staged_files().collect();
        assert_eq!(staged_files.len(), 3); // modified, added, deleted are staged

        let untracked_files: Vec<_> = status.untracked_entries().collect();
        assert_eq!(untracked_files.len(), 1);
        assert_eq!(untracked_files[0].path.to_str(), Some("untracked.txt"));

        assert!(!status.is_clean());
        assert!(status.has_changes());
    }

    #[test]
    fn test_clean_repository_status() {
        let output = "";
        let status = GitStatus::parse_porcelain_output(output);

        assert!(status.is_clean());
        assert!(!status.has_changes());
        assert_eq!(status.entries.len(), 0);
        assert_eq!(status.staged_files().count(), 0);
        assert_eq!(status.untracked_entries().count(), 0);
    }

    #[test]
    fn test_repository_status() {
        let test_path = env::temp_dir().join("test_status_repo");

        // Clean up if exists
        if test_path.exists() {
            fs::remove_dir_all(&test_path).unwrap();
        }

        // Create a repository
        let repo = Repository::init(&test_path, false).unwrap();

        // Get status of empty repository
        let status = repo.status().unwrap();
        assert!(status.is_clean());

        // Clean up
        fs::remove_dir_all(&test_path).unwrap();
    }

    #[test]
    fn test_parse_porcelain_output_edge_cases() {
        // Test empty lines and malformed lines
        let output = "\n\nM  valid.txt\nXX\n  \nA  another.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 2);

        let valid_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("valid.txt"))
            .unwrap();
        assert_eq!(valid_entry.index_status, IndexStatus::Modified);

        let another_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("another.txt"))
            .unwrap();
        assert_eq!(another_entry.index_status, IndexStatus::Added);
    }

    #[test]
    fn test_parse_porcelain_all_status_types() {
        let output = "M  modified.txt\nA  added.txt\nD  deleted.txt\nR  renamed.txt\nC  copied.txt\n?? untracked.txt\n!! ignored.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 7);

        let modified = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("modified.txt"))
            .unwrap();
        assert_eq!(modified.index_status, IndexStatus::Modified);

        let added = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("added.txt"))
            .unwrap();
        assert_eq!(added.index_status, IndexStatus::Added);

        let deleted = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("deleted.txt"))
            .unwrap();
        assert_eq!(deleted.index_status, IndexStatus::Deleted);

        let renamed = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("renamed.txt"))
            .unwrap();
        assert_eq!(renamed.index_status, IndexStatus::Renamed);

        let copied = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("copied.txt"))
            .unwrap();
        assert_eq!(copied.index_status, IndexStatus::Copied);

        let untracked = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("untracked.txt"))
            .unwrap();
        assert_eq!(untracked.worktree_status, WorktreeStatus::Untracked);

        let ignored = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("ignored.txt"))
            .unwrap();
        assert_eq!(ignored.worktree_status, WorktreeStatus::Ignored);
    }

    #[test]
    fn test_parse_porcelain_worktree_modifications() {
        let output = " M worktree_modified.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 1);
        let entry = &status.entries[0];
        assert_eq!(entry.path.to_str(), Some("worktree_modified.txt"));
        assert_eq!(entry.index_status, IndexStatus::Clean);
        assert_eq!(entry.worktree_status, WorktreeStatus::Modified);
    }

    #[test]
    fn test_parse_porcelain_unknown_status() {
        let output = "XY unknown.txt\nZ  another_unknown.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        // Unknown statuses should be treated as clean/clean and ignored
        assert_eq!(status.entries.len(), 0);
    }

    #[test]
    fn test_index_status_equality() {
        assert_eq!(IndexStatus::Modified, IndexStatus::Modified);
        assert_ne!(IndexStatus::Modified, IndexStatus::Added);
        assert_eq!(IndexStatus::Clean, IndexStatus::Clean);
    }

    #[test]
    fn test_worktree_status_equality() {
        assert_eq!(WorktreeStatus::Modified, WorktreeStatus::Modified);
        assert_ne!(WorktreeStatus::Modified, WorktreeStatus::Untracked);
        assert_eq!(WorktreeStatus::Clean, WorktreeStatus::Clean);
    }

    #[test]
    fn test_index_status_char_conversion() {
        // Test from_char
        assert_eq!(IndexStatus::from_char('M'), IndexStatus::Modified);
        assert_eq!(IndexStatus::from_char('A'), IndexStatus::Added);
        assert_eq!(IndexStatus::from_char('D'), IndexStatus::Deleted);
        assert_eq!(IndexStatus::from_char('R'), IndexStatus::Renamed);
        assert_eq!(IndexStatus::from_char('C'), IndexStatus::Copied);
        assert_eq!(IndexStatus::from_char(' '), IndexStatus::Clean);
        assert_eq!(IndexStatus::from_char('X'), IndexStatus::Clean); // unknown char

        // Test to_char
        assert_eq!(IndexStatus::Modified.to_char(), 'M');
        assert_eq!(IndexStatus::Added.to_char(), 'A');
        assert_eq!(IndexStatus::Deleted.to_char(), 'D');
        assert_eq!(IndexStatus::Renamed.to_char(), 'R');
        assert_eq!(IndexStatus::Copied.to_char(), 'C');
        assert_eq!(IndexStatus::Clean.to_char(), ' ');
    }

    #[test]
    fn test_worktree_status_char_conversion() {
        // Test from_char
        assert_eq!(WorktreeStatus::from_char('M'), WorktreeStatus::Modified);
        assert_eq!(WorktreeStatus::from_char('D'), WorktreeStatus::Deleted);
        assert_eq!(WorktreeStatus::from_char('?'), WorktreeStatus::Untracked);
        assert_eq!(WorktreeStatus::from_char('!'), WorktreeStatus::Ignored);
        assert_eq!(WorktreeStatus::from_char(' '), WorktreeStatus::Clean);
        assert_eq!(WorktreeStatus::from_char('X'), WorktreeStatus::Clean); // unknown char

        // Test to_char
        assert_eq!(WorktreeStatus::Modified.to_char(), 'M');
        assert_eq!(WorktreeStatus::Deleted.to_char(), 'D');
        assert_eq!(WorktreeStatus::Untracked.to_char(), '?');
        assert_eq!(WorktreeStatus::Ignored.to_char(), '!');
        assert_eq!(WorktreeStatus::Clean.to_char(), ' ');
    }

    #[test]
    fn test_bidirectional_char_conversion() {
        // Test that from_char(to_char(x)) == x for IndexStatus
        for status in [
            IndexStatus::Clean,
            IndexStatus::Modified,
            IndexStatus::Added,
            IndexStatus::Deleted,
            IndexStatus::Renamed,
            IndexStatus::Copied,
        ] {
            assert_eq!(IndexStatus::from_char(status.to_char()), status);
        }

        // Test that from_char(to_char(x)) == x for WorktreeStatus
        for status in [
            WorktreeStatus::Clean,
            WorktreeStatus::Modified,
            WorktreeStatus::Deleted,
            WorktreeStatus::Untracked,
            WorktreeStatus::Ignored,
        ] {
            assert_eq!(WorktreeStatus::from_char(status.to_char()), status);
        }
    }

    #[test]
    fn test_status_display() {
        // Test IndexStatus Display
        assert_eq!(format!("{}", IndexStatus::Modified), "M");
        assert_eq!(format!("{}", IndexStatus::Added), "A");
        assert_eq!(format!("{}", IndexStatus::Clean), " ");

        // Test WorktreeStatus Display
        assert_eq!(format!("{}", WorktreeStatus::Modified), "M");
        assert_eq!(format!("{}", WorktreeStatus::Untracked), "?");
        assert_eq!(format!("{}", WorktreeStatus::Clean), " ");
    }

    #[test]
    fn test_file_entry_equality() {
        let entry1 = FileEntry {
            path: PathBuf::from("test.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        };
        let entry2 = FileEntry {
            path: PathBuf::from("test.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        };
        let entry3 = FileEntry {
            path: PathBuf::from("other.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        };

        assert_eq!(entry1, entry2);
        assert_ne!(entry1, entry3);
    }

    #[test]
    fn test_git_status_equality() {
        let entries1 = vec![
            FileEntry {
                path: PathBuf::from("file1.txt"),
                index_status: IndexStatus::Modified,
                worktree_status: WorktreeStatus::Clean,
            },
            FileEntry {
                path: PathBuf::from("file2.txt"),
                index_status: IndexStatus::Added,
                worktree_status: WorktreeStatus::Clean,
            },
        ];
        let entries2 = entries1.clone();
        let entries3 = vec![FileEntry {
            path: PathBuf::from("different.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        }];

        let status1 = GitStatus {
            entries: entries1.into_boxed_slice(),
        };
        let status2 = GitStatus {
            entries: entries2.into_boxed_slice(),
        };
        let status3 = GitStatus {
            entries: entries3.into_boxed_slice(),
        };

        assert_eq!(status1, status2);
        assert_ne!(status1, status3);
    }

    #[test]
    fn test_git_status_clone() {
        let entries = vec![FileEntry {
            path: PathBuf::from("file1.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        }];
        let status1 = GitStatus {
            entries: entries.into_boxed_slice(),
        };
        let status2 = status1.clone();

        assert_eq!(status1, status2);
    }

    #[test]
    fn test_git_status_debug() {
        let entries = vec![FileEntry {
            path: PathBuf::from("file1.txt"),
            index_status: IndexStatus::Modified,
            worktree_status: WorktreeStatus::Clean,
        }];
        let status = GitStatus {
            entries: entries.into_boxed_slice(),
        };
        let debug_str = format!("{:?}", status);

        assert!(debug_str.contains("GitStatus"));
        assert!(debug_str.contains("Modified"));
        assert!(debug_str.contains("file1.txt"));
    }

    #[test]
    fn test_new_api_methods() {
        let output = "M  file1.txt\nMM file2.txt\nA  file3.txt\n D file4.txt\n?? file5.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        // Test staged files (index changes)
        let staged: Vec<_> = status.staged_files().collect();
        assert_eq!(staged.len(), 3); // M, MM, A (not D since it has clean index status)

        // Test unstaged files (worktree changes)
        let unstaged: Vec<_> = status.unstaged_files().collect();
        assert_eq!(unstaged.len(), 3); // MM, D, ??

        // Test untracked files
        let untracked: Vec<_> = status.untracked_entries().collect();
        assert_eq!(untracked.len(), 1);
        assert_eq!(untracked[0].path.to_str(), Some("file5.txt"));

        // Test index status filtering
        let modified_in_index: Vec<_> = status
            .files_with_index_status(IndexStatus::Modified)
            .collect();
        assert_eq!(modified_in_index.len(), 2); // file1.txt, file2.txt

        // Test worktree status filtering
        let modified_in_worktree: Vec<_> = status
            .files_with_worktree_status(WorktreeStatus::Modified)
            .collect();
        assert_eq!(modified_in_worktree.len(), 1); // file2.txt
    }

    #[test]
    fn test_parse_porcelain_filenames_with_spaces() {
        let output = "M  file with spaces.txt\nA  another file.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 2);

        let spaced_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("file with spaces.txt"))
            .unwrap();
        assert_eq!(spaced_entry.index_status, IndexStatus::Modified);

        let another_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("another file.txt"))
            .unwrap();
        assert_eq!(another_entry.index_status, IndexStatus::Added);
    }

    #[test]
    fn test_parse_porcelain_unicode_filenames() {
        let output = "M  测试文件.txt\nA  🚀rocket.txt\n";
        let status = GitStatus::parse_porcelain_output(output);

        assert_eq!(status.entries.len(), 2);

        let chinese_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("测试文件.txt"))
            .unwrap();
        assert_eq!(chinese_entry.index_status, IndexStatus::Modified);

        let rocket_entry = status
            .entries
            .iter()
            .find(|e| e.path.to_str() == Some("🚀rocket.txt"))
            .unwrap();
        assert_eq!(rocket_entry.index_status, IndexStatus::Added);
    }
}