use-dir 0.0.1

Practical directory path utility primitives
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

use use_dir::{
    dir_name, ensure_dir_trailing_separator, is_current_dir, is_parent_dir, is_root_dir,
    normalize_dir_path, path_depth, relative_to_dir, starts_with_dir, strip_dir_trailing_separator,
};

#[test]
fn extracts_directory_names() {
    assert_eq!(dir_name("docs/guides/intro.md").as_deref(), Some("guides"));
    assert_eq!(dir_name("docs/guides/").as_deref(), Some("guides"));
    assert_eq!(dir_name("docs").as_deref(), Some("docs"));
    assert_eq!(dir_name("/"), None);
}

#[test]
fn detects_root_current_and_parent_dirs() {
    assert!(is_root_dir("/"));
    assert!(is_root_dir(r"C:\"));
    assert!(is_root_dir(r"\\server\share"));
    assert!(is_current_dir("."));
    assert!(is_current_dir("./"));
    assert!(is_parent_dir(".."));
    assert!(is_parent_dir("../"));
}

#[test]
fn normalizes_and_adjusts_trailing_separators() {
    assert_eq!(normalize_dir_path(r"docs\guides\"), "docs/guides");
    assert_eq!(normalize_dir_path("/"), "/");
    assert_eq!(ensure_dir_trailing_separator("docs"), "docs/");
    assert_eq!(
        ensure_dir_trailing_separator(r"docs\guides"),
        "docs/guides/"
    );
    assert_eq!(strip_dir_trailing_separator("docs/guides/"), "docs/guides");
}

#[test]
fn calculates_path_depth() {
    assert_eq!(path_depth("docs/guides"), 2);
    assert_eq!(path_depth("docs/guides/getting-started"), 3);
    assert_eq!(path_depth("/"), 0);
    assert_eq!(path_depth(r"C:\Users\Joshua"), 2);
    assert_eq!(path_depth(r"\\server\share\folder"), 1);
}

#[test]
fn checks_directory_prefixes() {
    assert!(starts_with_dir("docs/guides/intro.md", "docs"));
    assert!(starts_with_dir("/tmp/logs/app.log", "/tmp"));
    assert!(!starts_with_dir("docs2/intro.md", "docs"));
    assert!(!starts_with_dir("docs/guides", "/tmp"));
}

#[test]
fn computes_relative_paths() {
    assert_eq!(
        relative_to_dir("docs/guides/intro.md", "docs").as_deref(),
        Some("guides/intro.md")
    );
    assert_eq!(relative_to_dir("docs", "docs").as_deref(), Some("."));
    assert_eq!(
        relative_to_dir("/tmp/logs/app.log", "/tmp").as_deref(),
        Some("logs/app.log")
    );
    assert_eq!(relative_to_dir("docs/guides", "other"), None);
}

#[test]
fn handles_empty_input() {
    assert_eq!(dir_name(""), None);
    assert_eq!(normalize_dir_path(""), "");
    assert_eq!(relative_to_dir("", ""), None);
}