html5-picture 0.2.3

Batch optimizes your images to wepb. Generates html5 picture tags.
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

use std::path::{Path, PathBuf};

/// Generates an output file name that is stored in the output working directory.
/// ## Example
///
/// ```
/// use {
///     html5_picture::path::create_output_file_name,
///     std::path::PathBuf,
/// };
///
/// let base_dir = PathBuf::from("../assets");
/// let input_file = PathBuf::from("../assets/some/picture.png");
/// let output_file = create_output_file_name(&base_dir, &input_file).unwrap();
/// assert_eq!(output_file.to_str().unwrap(), "../assets-html5picture/some/picture.png");
/// ```
pub fn create_output_file_name(
    base_dir: &PathBuf,
    input_file: &PathBuf,
) -> Result<PathBuf, String> {
    let output_base_dir = get_output_working_dir(&base_dir)?;
    let relative_file_name = remove_base_dir(&base_dir, &input_file)?;
    Ok(output_base_dir.join(relative_file_name))
}

/// Calculates the relative filename according to `base_dir` and `input_file`
/// and joins it with the `output_dir`.
/// ## Example
///
/// ```
/// use {
///     html5_picture::path::create_output_file_name_with_output_dir,
///     std::path::PathBuf,
/// };
///
/// let output_dir = PathBuf::from("../new-assets");
/// let base_dir = PathBuf::from("../assets");
/// let input_file = PathBuf::from("../assets/some/picture.png");
/// let output_file = create_output_file_name_with_output_dir(&output_dir, &base_dir, &input_file).unwrap();
/// assert_eq!(output_file.to_str().unwrap(), "../new-assets/some/picture.png");
/// ```
pub fn create_output_file_name_with_output_dir(
    output_dir: &PathBuf,
    base_dir: &PathBuf,
    input_file: &PathBuf,
) -> Result<PathBuf, String> {
    let relative_file_name = remove_base_dir(&base_dir, &input_file)?;
    Ok(output_dir.join(relative_file_name))
}

/// Generates the output directory name by attaching a fixed string to it.
/// ## Example
///
/// ```
/// use {
///     html5_picture::path::get_output_working_dir,
///     std::path::PathBuf,
/// };
///
/// let input = PathBuf::from("../assets");
/// let input = get_output_working_dir(&input).unwrap();
/// assert_eq!(input.to_str().unwrap(), "../assets-html5picture");
/// ```
pub fn get_output_working_dir(input_dir: &PathBuf) -> Result<PathBuf, String> {
    if let None = &input_dir.file_name() {
        return Err(String::from(
            "The last segment of the input path is not valid!",
        ));
    };
    // get input directory name
    let input_dir_name = input_dir.file_name().unwrap();
    // get parent directiory
    let parent = match input_dir.parent() {
        Some(p) => p,
        None => Path::new(""),
    };
    // generate output directory
    Ok(parent
        .join(format!("{}-html5picture", input_dir_name.to_str().unwrap())))
}

/// Removes the given base directory from the given input file.
/// ## Example
///
/// ```
/// use {
///     html5_picture::path::remove_base_dir,
///     std::path::PathBuf,
/// };
///
/// let base_dir = PathBuf::from("../assets");
/// let input_file = PathBuf::from("../assets/some_other/directory/picture.png");
/// let output = remove_base_dir(&base_dir, &input_file).unwrap();
/// assert_eq!(output.to_str().unwrap(), "some_other/directory/picture.png");
/// ```
pub fn remove_base_dir(
    base_dir: &PathBuf,
    input_file: &PathBuf,
) -> Result<PathBuf, String> {
    match pathdiff::diff_paths(input_file, base_dir) {
        Some(p) => Ok(p),
        None => match input_file.to_str() {
            Some(v) => {
                Err(String::from(format!("Could not remove base dir of {}", v)))
            }
            None => Err(String::from("Could not remove base dir!")),
        },
    }
}