dircat 1.0.0

High-performance Rust utility that concatenates and displays directory contents, similar to the C++ DirCat.
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

// src/processing/counter.rs

use crate::core_types::FileCounts;

/// Calculates line, character, and word counts for a string slice.
///
/// This function assumes the input is text. For binary content that has been lossily
/// converted to a string, only the `characters` (byte) count is reliable.
/// The calculation rules are as follows:
///
/// - **Lines**: The number of lines, calculated by counting newline (`\n`) characters.
/// - **Characters**: The total number of bytes in the string.
/// - **Words**: The number of words, calculated by splitting the content by whitespace.
///
/// # Examples
///
/// ```
/// use dircat::processing::calculate_counts;
///
/// let content = "Hello, world!\nThis is a test.";
/// let counts = calculate_counts(content);
/// assert_eq!(counts.lines, 2);
/// assert_eq!(counts.words, 6);
/// assert_eq!(counts.characters, 29);
/// ```
#[inline]
pub fn calculate_counts(content: &str) -> FileCounts {
    FileCounts {
        lines: content.lines().count(),
        characters: content.len(), // Number of bytes
        words: content.split_whitespace().count(),
    }
}

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

    #[test]
    fn test_counts_basic() {
        let content = "One two three.\nFour five.\n";
        let counts = calculate_counts(content);
        assert_eq!(counts.lines, 2);
        assert_eq!(counts.characters, 26); // Includes newline chars
        assert_eq!(counts.words, 5);
    }

    #[test]
    fn test_counts_empty_string() {
        let content = "";
        let counts = calculate_counts(content);
        assert_eq!(counts.lines, 0);
        assert_eq!(counts.characters, 0);
        assert_eq!(counts.words, 0);
    }

    #[test]
    fn test_counts_whitespace_only() {
        let content = "  \n\t \n ";
        let counts = calculate_counts(content);
        assert_eq!(counts.lines, 3); // lines() counts lines separated by \n
        assert_eq!(counts.characters, 7);
        assert_eq!(counts.words, 0); // split_whitespace finds no words
    }

    #[test]
    fn test_counts_no_trailing_newline() {
        let content = "One two";
        let counts = calculate_counts(content);
        assert_eq!(counts.lines, 1);
        assert_eq!(counts.characters, 7);
        assert_eq!(counts.words, 2);
    }

    #[test]
    fn test_counts_multiple_spaces() {
        let content = "One   two \t three";
        let counts = calculate_counts(content);
        assert_eq!(counts.lines, 1);
        assert_eq!(counts.characters, 17);
        assert_eq!(counts.words, 3); // split_whitespace handles multiple spaces
    }
}