csvpp 0.8.0

Compile csv++ source code to a target spreadsheet format
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

use crate::{CliArgs, Compiler, ModulePath, SourceCode};
use rand::Rng;
use std::fs;
use std::path;

/// Only to be used as a helper in tests, this makes it easy to create a text file that will get
/// cleaned up by the borrow checker.  It provides two important properties:
///
/// * A random filename -  we need this because tests run in parallel and will step on each
/// other's runs otherwise.
///
/// * A `Drop` trait impl - this makes sure the files get cleaned up after the tests run.  The
/// same functionality as an "after each" step in other test frameworks.
///
#[derive(Clone, Debug)]
pub(crate) struct TestSourceCode {
    pub(crate) input_file: path::PathBuf,
    pub(crate) output_file: path::PathBuf,
    in_dir: bool,
}

/// We frequently need to be able to produce a `Compiler` given a source file.
/// NOTE: It's important that this takes a reference to a `TestSourceCode` rather than an owned
/// struct, because if it took the latter it would immediately trigger the `Drop` impl which would
/// remove the files.  So we need to keep a reference open to it rather than owning it
impl From<&TestSourceCode> for Compiler {
    fn from(test_file: &TestSourceCode) -> Self {
        Self::try_from(&CliArgs {
            input_filename: test_file.input_file.clone(),
            output_filename: Some(test_file.output_file.clone()),
            ..Default::default()
        })
        .unwrap()
    }
}

impl From<&TestSourceCode> for ModulePath {
    fn from(tsc: &TestSourceCode) -> Self {
        ModulePath::try_from(tsc.input_file.clone()).unwrap()
    }
}

/// NOTE: It's important that this takes a reference to a `TestSourceCode` rather than an owned
/// struct, because if it took the latter it would immediately trigger the `Drop` impl which would
/// remove the files.  So we need to keep a reference open to it rather than owning it
impl From<&TestSourceCode> for SourceCode {
    fn from(test_file: &TestSourceCode) -> Self {
        Self::new(test_file.read_input(), test_file.input_file.clone())
    }
}

impl TestSourceCode {
    pub(crate) fn new(output_extension: &str, input: &str) -> Self {
        let mut rng = rand::thread_rng();

        let input_filename = format!("unit_test_input_{}.csvpp", rng.gen::<u64>());
        let source_path = path::Path::new(&input_filename);
        fs::write(source_path, input).unwrap();

        let output_filename = format!("unit_test_output_{}.{output_extension}", rng.gen::<u64>());
        let output_path = path::Path::new(&output_filename);

        Self {
            input_file: source_path.to_path_buf(),
            output_file: output_path.to_path_buf(),
            in_dir: false,
        }
    }

    pub(crate) fn new_in_dir(output_extension: &str, input: &str) -> Self {
        let mut rng = rand::thread_rng();
        let dir = rng.gen::<u64>().to_string();
        fs::create_dir(&dir).unwrap();
        let input_filename = format!("{dir}/unit_test_input_{}.csvpp", rng.gen::<u64>());
        let source_path = path::Path::new(&input_filename);
        fs::write(source_path, input).unwrap();

        let output_filename = format!(
            "{dir}/unit_test_output_{}.{output_extension}",
            rng.gen::<u64>()
        );
        let output_path = path::Path::new(&output_filename);

        Self {
            input_file: source_path.to_path_buf(),
            output_file: output_path.to_path_buf(),
            in_dir: true,
        }
    }

    #[allow(dead_code)]
    pub(crate) fn read_output(&self) -> String {
        fs::read_to_string(&self.output_file).unwrap()
    }

    fn object_code_filename(&self) -> path::PathBuf {
        let mut f = self.input_file.clone();
        f.set_extension("csvpo");
        f
    }

    fn read_input(&self) -> String {
        fs::read_to_string(&self.input_file).unwrap()
    }
}

// we purposefully don't care about the Result here since we're just doing our best effort to clean
// up.  if the first remove_file fails there's no reason for it to block the second one
#[allow(unused_must_use)]
impl Drop for TestSourceCode {
    fn drop(&mut self) {
        fs::remove_file(self.object_code_filename());
        fs::remove_file(&self.input_file);
        fs::remove_file(&self.output_file);

        if self.in_dir {
            fs::remove_dir(self.input_file.parent().unwrap()).unwrap();
        }
    }
}