rona 2.25.0

A simple CLI tool to help you with your git workflow.
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
//! Git Staging Operations
//!
//! File staging functionality with pattern exclusion and dry-run capabilities.

use std::{io::IsTerminal, process::Command, time::Duration};

use glob::Pattern;
use indicatif::{ProgressBar, ProgressDrawTarget};

use crate::errors::{GitError, Result, RonaError};

use super::{
    repository::get_top_level_path,
    status::{
        count_renamed_files, get_all_staged_file_paths, get_status_files,
        process_deleted_files_for_staging,
    },
};

/// Checks if a pattern matches a file path, considering both absolute (repo-relative)
/// and current-directory-relative patterns.
///
/// This function tries to match the pattern in multiple ways to provide intuitive behavior:
/// 1. Against the full path from repository root (e.g., "tp08-sujet/RESPONSE.md")
/// 2. Against the path relative to current directory (e.g., "RESPONSE.md" when in "tp08-sujet/")
/// 3. Against just the filename (for simple patterns like "RESPONSE.md")
///
/// # Arguments
/// * `pattern` - The glob pattern to match
/// * `file_path` - The file path relative to repository root
/// * `current_dir_rel_to_repo` - Current directory path relative to repo root (e.g., "tp08-sujet")
///
/// # Returns
/// `true` if the pattern matches the file in any of the supported ways, `false` otherwise
///
/// # Examples
/// ```
/// use glob::Pattern;
///
/// let pattern = Pattern::new("RESPONSE.md").unwrap();
/// let file_path = "tp08-sujet/RESPONSE.md";
/// let current_dir = Some("tp08-sujet");
///
/// // Matches because "RESPONSE.md" matches the filename
/// assert!(pattern_matches_file(&pattern, file_path, current_dir));
///
/// // Also matches with full path pattern
/// let pattern = Pattern::new("tp08-sujet/RESPONSE.md").unwrap();
/// assert!(pattern_matches_file(&pattern, file_path, None));
///
/// // Glob patterns work too
/// let pattern = Pattern::new("*/RESPONSE.md").unwrap();
/// assert!(pattern_matches_file(&pattern, file_path, None));
/// ```
fn pattern_matches_file(
    pattern: &Pattern,
    file_path: &str,
    current_dir_rel_to_repo: Option<&str>,
) -> bool {
    // Try matching against full path (root-relative or glob patterns)
    if pattern.matches(file_path) {
        return true;
    }

    // If we're in a subdirectory, also try matching against path relative to current dir
    if let Some(current_subdir) = current_dir_rel_to_repo
        && !current_subdir.is_empty()
    {
        // Remove the current directory prefix from the file path
        if let Some(relative_path) = file_path.strip_prefix(&format!("{current_subdir}/"))
            && pattern.matches(relative_path)
        {
            return true;
        }
    }

    // Also try matching just the filename (for simple patterns like "RESPONSE.md")
    if let Some(filename) = std::path::Path::new(file_path).file_name()
        && let Some(filename_str) = filename.to_str()
        && pattern.matches(filename_str)
    {
        return true;
    }

    false
}

/// Unstages a list of files from the index, restoring them to their HEAD state.
///
/// Uses `git restore --staged` when a HEAD commit exists (the correct way to
/// unstage modifications on tracked files), and falls back to `git rm --cached`
/// in a repo with no commits yet, where all staged entries are brand-new.
fn unstage_files(repo_root: &std::path::Path, files: &[String]) -> Result<()> {
    // `git restore --staged` requires HEAD; fall back for initial-commit repos.
    let head_exists = Command::new("git")
        .current_dir(repo_root)
        .args(["rev-parse", "--verify", "HEAD"])
        .output()
        .is_ok_and(|o| o.status.success());

    let (unstage_args, cmd_label): (&[&str], &str) = if head_exists {
        (&["restore", "--staged", "--"], "git restore --staged")
    } else {
        (&["rm", "--cached", "--"], "git rm --cached")
    };

    let output = Command::new("git")
        .current_dir(repo_root)
        .args(unstage_args)
        .args(files)
        .output()
        .map_err(RonaError::Io)?;

    if output.status.success() {
        return Ok(());
    }

    let stderr = String::from_utf8_lossy(&output.stderr);
    Err(RonaError::Git(GitError::CommandFailed {
        command: cmd_label.to_string(),
        output: stderr.trim().to_string(),
    }))
}

/// Adds files to the git index.
///
/// # Errors
/// * If reading git status fails
/// * If adding files to git fails
/// * If getting git staged information fails
///
/// # Examples
/// ```no_run
/// use std::error::Error;
/// use glob::Pattern;
///
/// // Exclude all Rust source files
/// let patterns = vec![Pattern::new("*.rs").unwrap()];
/// git_add_with_exclude_patterns(&patterns, true)?;
///
/// // Exclude an entire directory
/// let patterns = vec![Pattern::new("target/**/*").unwrap()];
/// git_add_with_exclude_patterns(&patterns, false)?;
///
/// // Multiple exclusion patterns
/// let patterns = vec![
///     Pattern::new("*.log").unwrap(),
///     Pattern::new("temp/*").unwrap(),
///     Pattern::new("**/*.tmp").unwrap()
/// ];
/// git_add_with_exclude_patterns(&patterns, true)?;
///
/// // Complex wildcard pattern
/// let patterns = vec![Pattern::new("src/**/*_test.{rs,txt}").unwrap()];
/// git_add_with_exclude_patterns(&patterns, false)?;
///
/// // No exclusions (empty pattern list)
/// let patterns = vec![];
/// git_add_with_exclude_patterns(&patterns, true)?;
///
/// // Pattern with special characters
/// let patterns = vec![Pattern::new("[abc]*.rs").unwrap()];
/// git_add_with_exclude_patterns(&patterns, false)?;
///
/// // Error handling example
/// fn handle_git_add() -> Result<(), Box<dyn Error>> {
///     let patterns = vec![Pattern::new("*.rs")?];
///     git_add_with_exclude_patterns(&patterns, true)?;
///     Ok(())
/// }
/// ```
///
/// In these examples:
/// - `"*.rs"` excludes all Rust source files
/// - `"target/**/*"` excludes everything in the target directory and subdirectories
/// - Multiple patterns show how to exclude logs, temp files, and .tmp files
/// - `"src/**/*_test.{rs,txt}"` excludes test files with .rs or .txt extensions in src/
/// - Empty vector shows how to add all files without exclusions
/// - `"[abc]*.rs"` excludes Rust files starting with a, b, or c
/// - Error handling shows proper pattern creation with error propagation
///
/// # Arguments
/// * `exclude_patterns` - List of patterns to exclude
/// * `verbose` - Whether to print verbose output
/// * `dry_run` - If true, only show what would be added without actually staging files
#[tracing::instrument(skip(exclude_patterns))]
pub fn git_add_with_exclude_patterns(
    exclude_patterns: &[Pattern],
    verbose: bool,
    dry_run: bool,
) -> Result<()> {
    tracing::debug!("Adding files...");

    // Get current directory relative to repo root
    let repo_root = get_top_level_path()?;
    let current_dir_rel_to_repo = {
        use std::env;

        let current_dir = env::current_dir().map_err(RonaError::Io)?;

        // Calculate relative path from repo root to current directory
        current_dir
            .strip_prefix(&repo_root)
            .ok()
            .and_then(|p| p.to_str())
            .map(String::from)
    };

    if dry_run {
        let deleted_files = process_deleted_files_for_staging()?;
        let all_files = get_status_files()?;
        let total_len = all_files.len() + deleted_files.len();

        let files_to_add: Vec<String> = all_files
            .into_iter()
            .filter(|f| {
                !exclude_patterns
                    .iter()
                    .any(|p| pattern_matches_file(p, f, current_dir_rel_to_repo.as_deref()))
            })
            .collect();
        let deleted_to_stage: Vec<String> = deleted_files
            .into_iter()
            .filter(|f| {
                !exclude_patterns
                    .iter()
                    .any(|p| pattern_matches_file(p, f, current_dir_rel_to_repo.as_deref()))
            })
            .collect();

        let excluded_count = total_len - files_to_add.len() - deleted_to_stage.len();
        print_dry_run_summary(&files_to_add, &deleted_to_stage, excluded_count);
        return Ok(());
    }

    let show_progress = std::io::stderr().is_terminal() && !verbose;
    let pb = if show_progress {
        let bar = ProgressBar::new_spinner();
        bar.set_draw_target(ProgressDrawTarget::stderr());
        bar.set_message("Staging files...");
        bar.enable_steady_tick(Duration::from_millis(80));
        Some(bar)
    } else {
        None
    };

    // Stage everything at once
    let output = Command::new("git")
        .current_dir(&repo_root)
        .args(["add", "-A"])
        .output()
        .map_err(RonaError::Io)?;

    if !output.status.success() {
        if let Some(bar) = &pb {
            bar.finish_and_clear();
        }
        let stderr = String::from_utf8_lossy(&output.stderr);
        return Err(RonaError::Git(GitError::CommandFailed {
            command: "git add -A".to_string(),
            output: stderr.trim().to_string(),
        }));
    }

    // Unstage files matching exclude patterns
    let staged_files = get_all_staged_file_paths()?;
    let total_staged = staged_files.len();

    let files_to_unstage: Vec<String> = staged_files
        .into_iter()
        .filter(|f| {
            exclude_patterns
                .iter()
                .any(|p| pattern_matches_file(p, f, current_dir_rel_to_repo.as_deref()))
        })
        .collect();

    if !files_to_unstage.is_empty()
        && let Err(e) = unstage_files(&repo_root, &files_to_unstage)
    {
        if let Some(bar) = &pb {
            bar.finish_and_clear();
        }
        return Err(e);
    }

    if let Some(bar) = pb {
        bar.finish_and_clear();
    }

    let excluded_count = files_to_unstage.len();
    let staged_count = total_staged - excluded_count;
    let renamed_count = count_renamed_files()?;

    println!(
        "Added {staged_count} files, renamed {renamed_count} while excluding {excluded_count} files for commit."
    );

    Ok(())
}

/// Stages an explicit list of files via `git add -- <files>`.
///
/// Used by the interactive add mode (`rona -a -i`) after the user has selected
/// which files to stage. Deletions are staged correctly because `git add`
/// records the removal of a tracked file that no longer exists.
///
/// # Arguments
/// * `files` - Paths (relative to the repository root) to stage
/// * `dry_run` - If true, only print what would be staged without staging anything
///
/// # Errors
/// * If locating the repository root fails
/// * If the `git add` command fails
pub fn git_add_files(files: &[String], dry_run: bool) -> Result<()> {
    if files.is_empty() {
        println!("No files selected.");
        return Ok(());
    }

    if dry_run {
        println!("Would stage {} files:", files.len());
        for file in files {
            println!("  + {file}");
        }
        return Ok(());
    }

    let repo_root = get_top_level_path()?;
    let output = Command::new("git")
        .current_dir(&repo_root)
        .args(["add", "--"])
        .args(files)
        .output()
        .map_err(RonaError::Io)?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        return Err(RonaError::Git(GitError::CommandFailed {
            command: "git add --".to_string(),
            output: stderr.trim().to_string(),
        }));
    }

    println!("Staged {} files for commit.", files.len());
    Ok(())
}

/// Unstages an explicit list of files from the index (`rona reset`).
///
/// Restores the given paths to their `HEAD` state in the index while leaving the
/// working tree untouched, so no local edits are lost. This is the inverse of
/// [`git_add_files`].
///
/// # Arguments
/// * `files` - Paths (relative to the repository root) to unstage
/// * `dry_run` - If true, only print what would be unstaged without staging anything
///
/// # Errors
/// * If locating the repository root fails
/// * If the underlying git command fails
pub fn git_unstage_files(files: &[String], dry_run: bool) -> Result<()> {
    if files.is_empty() {
        println!("No staged files to unstage.");
        return Ok(());
    }

    if dry_run {
        println!("Would unstage {} files:", files.len());
        for file in files {
            println!("  - {file}");
        }
        return Ok(());
    }

    let repo_root = get_top_level_path()?;
    unstage_files(&repo_root, files)?;

    println!("Unstaged {} files.", files.len());
    Ok(())
}

/// Discards working-tree changes for an explicit list of files (`rona restore`).
///
/// Runs `git restore -- <files>`, reverting each file to its staged (or `HEAD`)
/// state. This is destructive: uncommitted, unstaged edits to the listed files
/// are lost. Callers are expected to confirm with the user beforehand.
///
/// # Arguments
/// * `files` - Paths (relative to the repository root) to restore
/// * `dry_run` - If true, only print what would be restored without changing anything
///
/// # Errors
/// * If locating the repository root fails
/// * If the `git restore` command fails
pub fn git_restore_files(files: &[String], dry_run: bool) -> Result<()> {
    if files.is_empty() {
        println!("No files to restore.");
        return Ok(());
    }

    if dry_run {
        println!("Would restore {} files:", files.len());
        for file in files {
            println!("  - {file}");
        }
        return Ok(());
    }

    let repo_root = get_top_level_path()?;
    let output = Command::new("git")
        .current_dir(&repo_root)
        .args(["restore", "--"])
        .args(files)
        .output()
        .map_err(RonaError::Io)?;

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        return Err(RonaError::Git(GitError::CommandFailed {
            command: "git restore --".to_string(),
            output: stderr.trim().to_string(),
        }));
    }

    println!("Restored {} files.", files.len());
    Ok(())
}

/// Prints a detailed summary of files that would be affected by a git add operation in dry run mode.
///
/// This function provides a clear overview of:
/// - Files that would be added to the staging area
/// - Files that would be deleted
/// - Number of files that would be excluded based on patterns
///
/// The output is formatted as follows:
/// ```
/// Would add N files:
///   + file1.txt
///   + file2.rs
/// Would delete M files:
///   - deleted_file1.txt
///   - deleted_file2.rs
/// Would exclude K files
/// ```
///
/// # Arguments
/// * `files_to_add` - List of files that would be added to the staging area
/// * `deleted_files` - List of files that would be marked as deleted
/// * `staged_files_len` - Total number of files that would be staged (including excluded ones)
/// ```
fn print_dry_run_summary(
    files_to_add: &[String],
    deleted_files: &[String],
    staged_files_len: usize,
) {
    println!("Would add {} files:", files_to_add.len());
    for file in files_to_add {
        println!("  + {file}");
    }

    println!("Would delete {} files:", deleted_files.len());
    for file in deleted_files {
        println!("  - {file}");
    }

    let excluded_files_len = staged_files_len - files_to_add.len();
    println!("Would exclude {excluded_files_len} files");
}

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

    #[test]
    fn test_pattern_matches_file_full_path() -> std::result::Result<(), Box<dyn std::error::Error>>
    {
        let pattern = Pattern::new("tp08-sujet/RESPONSE.md")?;
        let file_path = "tp08-sujet/RESPONSE.md";

        // Should match with full path pattern
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_file_relative_to_current_dir()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("RESPONSE.md")?;
        let file_path = "tp08-sujet/RESPONSE.md";
        let current_dir = Some("tp08-sujet");

        // Should match when pattern is relative to current directory
        assert!(pattern_matches_file(&pattern, file_path, current_dir));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_file_filename_only()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("RESPONSE.md")?;
        let file_path = "some/nested/dir/RESPONSE.md";

        // Should match just the filename even without current_dir context
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_file_glob_pattern()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("*/RESPONSE.md")?;
        let file_path = "tp08-sujet/RESPONSE.md";

        // Should match with glob pattern
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_file_double_star_glob()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("**/RESPONSE.md")?;
        let file_path = "some/deep/nested/dir/RESPONSE.md";

        // Should match with double-star glob pattern
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_does_not_match() -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("README.md")?;
        let file_path = "tp08-sujet/RESPONSE.md";

        // Should not match different filename
        assert!(!pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_relative_path_in_subdirectory()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("src/main.java")?;
        let file_path = "tp08-sujet/src/main.java";
        let current_dir = Some("tp08-sujet");

        // Should match relative path from current directory
        assert!(pattern_matches_file(&pattern, file_path, current_dir));
        Ok(())
    }

    #[test]
    fn test_pattern_matches_nested_path_from_root()
    -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("tp08-sujet/src/main.java")?;
        let file_path = "tp08-sujet/src/main.java";

        // Should match full path from repository root
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_with_extension_wildcard() -> std::result::Result<(), Box<dyn std::error::Error>>
    {
        let pattern = Pattern::new("*.md")?;
        let file_path = "tp08-sujet/RESPONSE.md";

        // Should match with extension wildcard
        assert!(pattern_matches_file(&pattern, file_path, None));
        Ok(())
    }

    #[test]
    fn test_pattern_at_repo_root() -> std::result::Result<(), Box<dyn std::error::Error>> {
        let pattern = Pattern::new("README.md")?;
        let file_path = "README.md";
        let current_dir = Some(""); // At repository root

        // Should match when at repository root
        assert!(pattern_matches_file(&pattern, file_path, current_dir));
        Ok(())
    }
}