nym 0.1.0

Manipulate files en masse using patterns.
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

use faccess::PathExt as _;
use std::path::{Path, PathBuf};
use thiserror::Error;

use crate::environment::Environment;
use crate::glob::GlobError;
use crate::manifest::{Manifest, ManifestError, Routing};
use crate::pattern::{FromPattern, PatternError, ToPattern};

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum TransformError {
    #[error("failed to traverse directory tree: {0}")]
    Read(GlobError),
    #[error("failed to resolve to-pattern: {0}")]
    PatternResolution(PatternError),
    #[error("failed to insert route: {0}")]
    RouteInsertion(ManifestError),
    #[error("destination is a directory: `{0}`")]
    DestinationNotAFile(PathBuf),
    #[error("destination file already exists: `{0}`")]
    DestinationAlreadyExists(PathBuf),
    #[error("destination parent directory does not exist: `{0}`")]
    DestinationOrphaned(PathBuf),
    #[error("cannot write to destination: `{0}`")]
    DestinationNotWritable(PathBuf),
    #[error("cannot read from source: `{0}`")]
    SourceNotReadable(PathBuf),
}

#[derive(Clone, Debug)]
pub struct Transform<'e, 'f, 't> {
    environment: &'e Environment,
    from: FromPattern<'f>,
    to: ToPattern<'t>,
}

impl<'e, 'f, 't> Transform<'e, 'f, 't> {
    pub(in crate) fn new(
        environment: &'e Environment,
        from: FromPattern<'f>,
        to: ToPattern<'t>,
    ) -> Self {
        Transform {
            environment,
            from,
            to,
        }
    }

    pub fn read<M>(
        &self,
        directory: impl AsRef<Path>,
        depth: usize,
    ) -> Result<Manifest<M>, TransformError>
    where
        M: Routing,
    {
        #[cfg(windows)]
        fn normalize(path: impl Into<PathBuf>) -> PathBuf {
            use path_slash::PathBufExt as _;

            PathBuf::from_slash_lossy(path.into())
        }

        #[cfg(not(windows))]
        #[inline(always)]
        fn normalize(path: impl Into<PathBuf>) -> PathBuf {
            path.into()
        }

        let mut manifest = Manifest::default();
        for entry in self.from.read(directory.as_ref(), depth) {
            let entry = entry.map_err(TransformError::Read)?;
            let source = entry.path();
            let mut destination = directory.as_ref().to_path_buf();
            destination.push(
                self.to
                    .resolve(&source, entry.captures())
                    .map_err(TransformError::PatternResolution)?,
            );
            self.verify_route_policy(source, &destination)?;
            manifest
                .insert(normalize(source), normalize(destination))
                .map_err(TransformError::RouteInsertion)?;
        }
        Ok(manifest)
    }

    // TODO: Are write permissions checked properly here? Parent directories are
    //       not queried directly.
    fn verify_route_policy(
        &self,
        source: impl AsRef<Path>,
        destination: impl AsRef<Path>,
    ) -> Result<(), TransformError> {
        let policy = self.environment.policy();
        let source = source.as_ref();
        let destination = destination.as_ref();
        if !source.readable() {
            return Err(TransformError::SourceNotReadable(source.into()));
        }
        if let Ok(metadata) = destination.metadata() {
            if policy.overwrite {
                if metadata.is_dir() {
                    return Err(TransformError::DestinationNotAFile(destination.into()));
                }
                else if !destination.writable() {
                    return Err(TransformError::DestinationNotWritable(destination.into()));
                }
            }
            else {
                return Err(TransformError::DestinationAlreadyExists(destination.into()));
            }
        }
        else {
            let parent = destination
                .parent()
                .expect("destination path has no parent");
            if policy.parents {
                let parent = parent
                    .ancestors()
                    .find(|path| path.exists())
                    .expect("destination path has no existing ancestor");
                if !parent.writable() {
                    return Err(TransformError::DestinationNotWritable(destination.into()));
                }
            }
            else {
                if !parent.exists() {
                    return Err(TransformError::DestinationOrphaned(destination.into()));
                }
                if !parent.writable() {
                    return Err(TransformError::DestinationNotWritable(destination.into()));
                }
            }
        }
        Ok(())
    }
}