web-static-pack-packer 0.5.2

Installable web-static-pack-packer tool for web-static-pack crate
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

//! Pack path helpers. Contains [from_file_base_relative_path] that creates pack
//! paths from fs paths.

use crate::common::pack_path::PackPath;
use anyhow::{Error, anyhow, ensure};
use std::{
    iter,
    path::{Component, Path},
};

/// Creates pack path (eg. "/dir1/dir2/file.html") from relative fs path (eg.
/// "workdir\\dir1\\dir2\\file.html").
///
/// # Examples
///
/// ```
/// # use anyhow::Error;
/// # use std::path::PathBuf;
/// # use web_static_pack_packer::{
/// #    common::pack_path::PackPath, pack_path::from_file_base_relative_path,
/// # };
/// #
/// # fn main() -> Result<(), Error> {
/// #
/// assert_eq!(
///     from_file_base_relative_path(&PathBuf::from("path\\to\\file.txt"))?,
///     PackPath::from_string("/path/to/file.txt".to_owned()),
/// );
/// #
/// # Ok(())
/// # }
/// ```
pub fn from_file_base_relative_path(file_base_relative_path: &Path) -> Result<PackPath, Error> {
    assert!(file_base_relative_path.is_relative());

    // list of path components, eg. ["dir1", "dir2", "file.bin"]
    let file_base_relative_path_components = file_base_relative_path
        .components()
        .map(|component| {
            // we cannot handle things like '/' or '.' or '..' here
            ensure!(
                matches!(component, Component::Normal(_)),
                "relative path must not contain only standard path items, got {:?}",
                component
            );

            component
                .as_os_str()
                .to_str()
                .ok_or_else(|| anyhow!("cannot convert path component to string"))
        })
        .collect::<Result<Vec<_>, Error>>()?;

    // we add empty element at the beginning to have path starting with /
    let pack_path_string = itertools::join(
        iter::once("").chain(file_base_relative_path_components),
        "/",
    );

    // convert into pack path
    let pack_path = PackPath::from_string(pack_path_string);

    Ok(pack_path)
}

#[cfg(test)]
mod test {
    use super::from_file_base_relative_path;
    use crate::common::pack_path::PackPath;
    use std::path::{Path, PathBuf};
    use test_case::test_case;

    #[test_case(
        &PathBuf::from("somefile"),
        &PackPath::from_string("/somefile".to_owned());
        "base file path without prefix"
    )]
    #[test_case(
        &PathBuf::from("linux/like/relative/path.html"),
        &PackPath::from_string("/linux/like/relative/path.html".to_owned());
        "linux like relative path"
    )]
    #[test_case(
        &PathBuf::from("Project\\MyApp\\Application.js"),
        &PackPath::from_string("/Project/MyApp/Application.js".to_owned());
        "windows relative path"
    )]
    fn from_file_base_relative_path_returns_expected(
        path: &Path,
        expected: &PackPath,
    ) {
        assert_eq!(&from_file_base_relative_path(path).unwrap(), expected);
    }
}