fiffy 0.1.10

A Rust library intended for simple file processing
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

// Include Rust's linter, Clippy, as an optional dependency
#![cfg_attr(feature = "clippy", feature(plugin))]
#![cfg_attr(feature = "clippy", plugin(clippy))]

// Crate that provides SHA1 and MD5 hashing functionality
extern crate crypto;

// Necessary libraries for required functionality
use std::fs;
use std::fs::File;
use std::io::Read;
use std::path::Path;
use std::ffi::OsString;
use crypto::digest::Digest;
use crypto::sha1::Sha1;
use crypto::md5::Md5;

/// Returns the file name of a given string representing the (absolute or relative) file path
pub fn get_file_name(file_path: &str) -> OsString {
    let path = Path::new(file_path.trim());
    path.file_name().unwrap().to_os_string()
}

/// Returns the file size in bytes of a given a string representing the (absolute or relative) file path
pub fn get_file_size(file_path: &str) -> u64 {
    // Returns a Result<> which MUST be handled for exceptions
    match fs::metadata(file_path.trim()) {
        Ok(metadata) => metadata.len(),
        Err(_e) => 0,
    }
}

/// Returns the SHA1 hash of a given a string representing the (absolute or relative) file path
pub fn generate_sha1(file_path: &str) -> String {
    let mut file = File::open(file_path.trim()).expect("File Not Found!");
    let mut file_contents = String::new();

    // Read all of the contents from the file into file_contents
    file.read_to_string(&mut file_contents)
        .expect("Something went wrong reading the file!");

    let mut sha_hash = Sha1::new();
    sha_hash.input_str(&file_contents.to_string());

    // Retun the string equivalent of the SHA1 hash
    sha_hash.result_str()
}

/// Returns the MD5 hash of a given a string representing the (absolute or relative) file path
pub fn generate_md5(file_path: &str) -> String {
    let mut file = File::open(file_path.trim()).expect("File Not Found!");
    let mut file_contents = String::new();

    // Store all of the contents of the file into file_contents
    file.read_to_string(&mut file_contents)
        .expect("Something went wrong reading the file!");

    let mut md5_hash = Md5::new();
    md5_hash.input_str(&file_contents.to_string());

    // Retun the string equivalent of the MD5 hash
    md5_hash.result_str()
}

/// Test Suite
#[cfg(test)]
mod tests {
    #[test]
    fn get_file_name() {
        use std::ffi::OsString;
        use get_file_name;

        let file_name = OsString::from("lazydog.txt");

        // Check if the function returns the expected name
        assert_eq!(get_file_name("/Desktop/lazydog.txt"), file_name);

        // Check if the length of the function's result is the expected size
        assert_eq!(get_file_name("/Desktop/lazydog.txt").len(), file_name.len());
    }

    #[test]
    fn get_file_size() {
        use get_file_size;

        // Expected file size for "lazydog.txt" - 43 bytes
        let file_size: u64 = 43;

        assert_eq!(get_file_size("lazydog.txt"), file_size);
    }

    #[test]
    fn calc_sha1() {
        use generate_sha1;

        let sha1_hash = String::from("2fd4e1c67a2d28fced849ee1bb76e7391b93eb12");

        // Check if the function returns the expected SHA1 hash
        assert_eq!(generate_sha1("lazydog.txt"), sha1_hash);

        // Check if the length of the function's result is the expected size
        assert_eq!(generate_sha1("lazydog.txt").len(), sha1_hash.len());
    }

    #[test]
    fn calc_md5() {
        use generate_md5;

        let md5_hash = String::from("9e107d9d372bb6826bd81d3542a419d6");

        // Check if the function returns the expected MD5 hash
        assert_eq!(generate_md5("lazydog.txt"), md5_hash);

        // Check if the length of the function's result is the expected size
        assert_eq!(generate_md5("lazydog.txt").len(), md5_hash.len());;
    }
}