sheepit 0.5.1

A simple rust tool for releasing projects 🚀
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
147
148
149
150
151
152
153
154
155
156
157
158

use crate::config::TransformConfig;
#[double]
use crate::file::{FileReader, FileWriter};
use crate::transform::file_transform::FileTransformer;
use crate::version::update::VersionUpdate;
use crate::SheepError;
use mockall_double::double;
use std::collections::BTreeSet;
use std::path::{Path, PathBuf};

pub struct ProjectTransformer {
    file_reader: FileReader,
    file_writer: FileWriter,
    project_path: PathBuf,
}
impl ProjectTransformer {
    #[cfg(test)]
    pub fn for_tests(
        file_reader: FileReader,
        file_writer: FileWriter,
        project_path: PathBuf,
    ) -> Self {
        ProjectTransformer {
            file_reader,
            file_writer,
            project_path,
        }
    }

    pub fn new<P: AsRef<Path>>(project_path: P) -> Self {
        ProjectTransformer {
            file_reader: FileReader::new(),
            file_writer: FileWriter::new(),
            project_path: project_path.as_ref().to_path_buf(),
        }
    }

    pub fn transform(
        &self,
        configs: &Vec<TransformConfig>,
        version_update: &VersionUpdate,
    ) -> Result<Vec<String>, SheepError> {
        let transformers: Vec<FileTransformer> = configs
            .iter()
            .map(|c| {
                FileTransformer::new(c, &self.file_reader, &self.file_writer, &self.project_path)
            })
            .collect();

        let mut paths: BTreeSet<String> = BTreeSet::new();
        for transformer in transformers {
            let path = transformer.transform(version_update)?;
            paths.insert(path);
        }
        Ok(Vec::from_iter(paths))
    }
}

#[cfg(test)]
mod test {
    use crate::config::TransformConfig;
    use crate::file::{MockFileReader, MockFileWriter};
    use crate::transform::project_transform::ProjectTransformer;
    use crate::version::update::VersionUpdate;
    use crate::SheepError;
    use semver::Version;
    use std::path::PathBuf;

    const PATH_1: &str = "path_1";
    const PATH_2: &str = "path_2";
    const PROJECT_PATH: &str = "project";
    const FULL_PATH_1: &str = "project/path_1";
    const FULL_PATH_2: &str = "project/path_2";

    #[test]
    fn transform_file_transform_error() {
        let project_transformer = ProjectTransformer::for_tests(
            failed_reader(),
            MockFileWriter::default(),
            PathBuf::from(PROJECT_PATH),
        );
        project_transformer
            .transform(&configs(), &version_update())
            .expect_err("should have failed");
    }

    #[test]
    fn transform_applies_all_transforms() {
        let reader = mock_reader("first_1.0.0".to_string(), "second_1.0.0".to_string());
        let writer = mock_writer("first_2.0.0".to_string(), "second_2.0.0".to_string());
        let project_transformer =
            ProjectTransformer::for_tests(reader, writer, PathBuf::from(PROJECT_PATH));
        let paths = project_transformer
            .transform(&configs(), &version_update())
            .expect("transform fails");
        assert_eq!(paths, vec![PATH_1.to_string(), PATH_2.to_string()])
    }

    fn failed_reader() -> MockFileReader {
        let mut mock = MockFileReader::default();
        mock.expect_read_to_string()
            .return_once(|_| Err(SheepError::new("transform fail")));
        mock
    }

    fn mock_reader(first_text_read: String, second_text_read: String) -> MockFileReader {
        let mut mock = MockFileReader::default();
        mock.expect_read_to_string()
            .withf_st(|p| p.as_ref().to_str().unwrap() == FULL_PATH_1)
            .return_once(|_| Ok(first_text_read));
        mock.expect_read_to_string()
            .withf_st(|p| p.as_ref().to_str().unwrap() == FULL_PATH_2)
            .returning(move |_| Ok(second_text_read.clone()));
        mock
    }

    fn mock_writer(first_expected: String, second_expected: String) -> MockFileWriter {
        let mut mock = MockFileWriter::default();
        mock.expect_write_string_to_file()
            .withf_st(move |p, t| {
                p.as_ref().to_str().unwrap() == FULL_PATH_1 && t == first_expected
            })
            .return_once(|_, _| Ok(()));
        mock.expect_write_string_to_file()
            .withf_st(move |p, t| {
                p.as_ref().to_str().unwrap() == FULL_PATH_2 && t == second_expected
            })
            .returning(|_, _| Ok(()));
        mock
    }

    fn configs() -> Vec<TransformConfig> {
        vec![
            TransformConfig {
                path: PATH_1.to_string(),
                find: None,
                replace: "first_{version}".to_string(),
            },
            TransformConfig {
                path: PATH_2.to_string(),
                find: None,
                replace: "second_{version}".to_string(),
            },
            TransformConfig {
                path: PATH_2.to_string(),
                find: None,
                replace: "second_{version}".to_string(),
            }, // Used to verify we filter duplicate output paths
        ]
    }

    fn version_update() -> VersionUpdate {
        VersionUpdate {
            current_version: Version::parse("1.0.0").expect("failed to parse version"),
            next_version: Version::parse("2.0.0").expect("failed to parse version"),
        }
    }
}