putter 0.1.0

A tool to put files in the right place
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

use std::{fs, io, path::Path};

/// Determines whether the two given paths are files having the same content.
pub fn file_eq(path1: &Path, path2: &Path) -> io::Result<bool> {
    let path1 = &path1.canonicalize()?;
    let path2 = &path2.canonicalize()?;

    // If the two paths canonicalize to the exact same path, then they are
    // trivially equal.
    if path1 == path2 {
        return Ok(true);
    }

    if fs::metadata(path1)?.len() != fs::metadata(path2)?.len() {
        return Ok(false);
    }

    Ok(fs::read(path1)? == fs::read(path2)?)
}

#[cfg(test)]
mod tests {
    use super::*;
    use assert_fs::prelude::{FileWriteStr, PathChild, SymlinkToFile};
    use std::{io, path::Path};

    #[test]
    fn files_with_same_canonicalized_paths_returns_true() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file1 = dir.child("file1");

        // An alternative way to express the path to file1. Specifically, if
        // file1 is /foo/bar/file1 then the alternative is
        // /foo/bar/../bar/file1.
        let file1_alt = {
            let mut f = dir.to_path_buf();
            f.push("..");
            f.push(dir.file_name().unwrap());
            f.push(file1.file_name().unwrap());
            f
        };

        file1.write_str("abc").unwrap();

        let actual = file_eq(&file1, &file1_alt);
        assert!(actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn symlinks_leading_to_same_file_returns_true() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file = dir.child("file");
        let symlink1 = dir.child("symlink1");
        let symlink2a = dir.child("symlink2a");
        let symlink2b = dir.child("symlink2b");

        file.write_str("abc").unwrap();

        symlink1.symlink_to_file(&file).unwrap();
        symlink2a.symlink_to_file(&file).unwrap();
        symlink2b.symlink_to_file(&symlink2a).unwrap();

        let actual = file_eq(&symlink1, &symlink2b);
        assert!(actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn symlinks_leading_to_same_directory_returns_true() {
        let dir = assert_fs::TempDir::new().unwrap();
        let subdir = dir.child("subdir");
        let symlink1 = dir.child("symlink1");
        let symlink2a = dir.child("symlink2a");
        let symlink2b = dir.child("symlink2b");

        subdir.write_str("abc").unwrap();

        symlink1.symlink_to_file(&subdir).unwrap();
        symlink2a.symlink_to_file(&subdir).unwrap();
        symlink2b.symlink_to_file(&symlink2a).unwrap();

        let actual = file_eq(&symlink1, &symlink2b);
        assert!(actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn files_with_same_content_returns_true() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file1 = dir.child("file1");
        let file2 = dir.child("file2");

        file1.write_str("abc").unwrap();
        file2.write_str("abc").unwrap();

        let actual = file_eq(&file1, &file2);
        assert!(actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn files_of_different_size_returns_false() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file1 = dir.child("file1");
        let file2 = dir.child("file2");

        file1.write_str("abc").unwrap();
        file2.write_str("abcd").unwrap();

        let actual = file_eq(&file1, &file2);
        assert!(!actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn files_of_same_size_but_different_content_returns_false() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file1 = dir.child("file1");
        let file2 = dir.child("file2");

        file1.write_str("abc").unwrap();
        file2.write_str("xyz").unwrap();

        let actual = file_eq(&file1, &file2);
        assert!(!actual.unwrap());

        dir.close().unwrap();
    }

    #[test]
    fn bad_path_returns_path_not_found() {
        let dir = assert_fs::TempDir::new().unwrap();
        let file1 = dir.child("file1");

        file1.write_str("abc").unwrap();

        let actual = file_eq(&file1, Path::new("no-such-file"));
        assert_eq!(actual.unwrap_err().kind(), io::ErrorKind::NotFound);
    }
}