cleansh 0.1.11

Sanitize your terminal output. One tool. One purpose.
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

//! Module for displaying differences between original and sanitized content.
//!
//! This module provides functionality to generate and print a human-readable
//! diff view, highlighting added and removed lines, typically used to show
//! the changes made by the redaction process. It leverages the `diffy` crate
//! for patch generation and a custom styling helper for colored terminal output.

use crate::ui::theme::{ThemeEntry, ThemeMap};
use std::io::Write;
use anyhow::Result;
use diffy::{create_patch, Line};

// Import get_styled_text from output_format
use crate::ui::output_format::get_styled_text;

/// Prints a diff view of the original and sanitized content to the given writer.
///
/// This function takes two string slices, `original_content` and `sanitized_content`,
/// computes their differences, and prints a standard diff-like output.
/// Lines present only in the original content are marked with '-' and colored red,
/// lines present only in the sanitized content are marked with '+' and colored green,
/// and common lines are shown without a prefix.
///
/// The diff header and footer are styled using `ThemeEntry::DiffHeader`.
///
/// # Type Parameters
///
/// * `W`: A type that implements `std::io::Write`, allowing output to various destinations
///         like `io::stdout()`, `io::stderr()`, or a file.
///
/// # Arguments
///
/// * `original_content` - The original string content before any sanitization.
/// * `sanitized_content` - The string content after sensitive data has been (potentially) sanitized.
/// * `writer` - The output writer where the diff will be printed (e.g., `&mut io::stdout()`).
/// * `theme_map` - A `HashMap` containing the defined `ThemeStyle`s to apply colors to the output.
/// * `enable_colors` - A boolean flag indicating whether ANSI colors should be used in the output.
///
/// # Returns
///
/// A `Result` indicating `Ok(())` on successful write operations or an `Err`
/// if any writing to the `writer` fails.
pub fn print_diff<W: Write>(
    original_content: &str,
    sanitized_content: &str,
    writer: &mut W,
    theme_map: &ThemeMap,
    enable_colors: bool,
) -> Result<()> {
    let diff_header = get_styled_text("\n--- Diff View ---", ThemeEntry::DiffHeader, theme_map, enable_colors);
    writeln!(writer, "{}", diff_header)?;

    let patch = create_patch(original_content, sanitized_content);

    for hunk in patch.hunks() {
        for line_change in hunk.lines() {
            let content_str = match line_change {
                Line::Delete(s) => s,
                Line::Insert(s) => s,
                Line::Context(s) => s,
            };

            // `diffy` might escape newlines as `\n` in content; replace them back to actual newlines
            let s_with_actual_newlines = content_str.replace("\\n", "\n");

            for segment in s_with_actual_newlines.lines() {
                match line_change {
                    Line::Delete(_) => {
                        let styled_line = get_styled_text(
                            &format!("-{}", segment),
                            ThemeEntry::DiffRemoved,
                            theme_map,
                            enable_colors,
                        );
                        writeln!(writer, "{}", styled_line)?;
                    }
                    Line::Insert(_) => {
                        let styled_line = get_styled_text(
                            &format!("+{}", segment),
                            ThemeEntry::DiffAdded,
                            theme_map,
                            enable_colors,
                        );
                        writeln!(writer, "{}", styled_line)?;
                    }
                    Line::Context(_) => {
                        // Context lines are prefixed with a space for alignment with diff output
                        writeln!(writer, " {}", segment)?;
                    }
                }
            }
        }
    }
    let diff_footer = get_styled_text("-----------------", ThemeEntry::DiffHeader, theme_map, enable_colors);
    writeln!(writer, "{}", diff_footer)?;
    Ok(())
}