summaryrefslogtreecommitdiffstats
path: root/src/modules/rlang.rs
blob: e6cac083f362317b01de3b55f9a835fe0b3dd150 (plain)
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
159
use super::{Context, Module, RootModuleConfig};
use crate::formatter::VersionFormatter;

use crate::configs::rlang::RLangConfig;
use crate::formatter::StringFormatter;

pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
    let mut module = context.new_module("rlang");
    let config: RLangConfig = RLangConfig::try_load(module.config);

    let is_r_project = context
        .try_begin_scan()?
        .set_files(&config.detect_files)
        .set_extensions(&config.detect_extensions)
        .set_folders(&config.detect_folders)
        .is_match();
    if !is_r_project {
        return None;
    }

    let parsed = StringFormatter::new(config.format).and_then(|formatter| {
        formatter
            .map_meta(|var, _| match var {
                "symbol" => Some(config.symbol),
                _ => None,
            })
            .map_style(|variable| match variable {
                "style" => Some(Ok(config.style)),
                _ => None,
            })
            .map(|variable| match variable {
                "version" => {
                    let r_version = get_r_version(context)?;
                    VersionFormatter::format_module_version(
                        module.get_name(),
                        &r_version,
                        config.version_format,
                    )
                    .map(Ok)
                }
                _ => None,
            })
            .parse(None)
    });

    module.set_segments(match parsed {
        Ok(segments) => segments,
        Err(error) => {
            log::warn!("Error in module `rlang`:\n{}", error);
            return None;
        }
    });

    Some(module)
}

fn get_r_version(context: &Context) -> Option<String> {
    let r_version = context.exec_cmd("R", &["--version"])?.stderr;
    parse_version(&r_version)
}

fn parse_version(r_version: &str) -> Option<String> {
    r_version
        .lines()
        // take first line
        .next()?
        // split into ["R", "version", "3.6.3", "(2020-02-29)", ...]
        .split_whitespace()
        // and pick version entry at index 2, i.e. "3.6.3".
        .nth(2)
        .map(ToString::to_string)
}

#[cfg(test)]
mod tests {
    use super::parse_version;
    use crate::test::ModuleRenderer;
    use ansi_term::Color;
    use std::fs;
    use std::fs::File;
    use std::io;

    #[test]
    fn test_parse_r_version() {
        let r_v3 = r#"R version 4.1.0 (2021-05-18) -- "Camp Pontanezen"
Copyright (C) 2021 The R Foundation for Statistical Computing
Platform: x86_64-w64-mingw32/x64 (64-bit)\n

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under the terms of the
GNU General Public License versions 2 or 3.
For more information about these matters see
https://www.gnu.org/licenses/."#;
        assert_eq!(parse_version(r_v3), Some(String::from("4.1.0")));
    }

    #[test]
    fn folder_with_r_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join("analysis.R"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rd_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join("analysis.Rd"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rmd_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join("analysis.Rmd"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rproj_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join("analysis.Rproj"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rsx_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join("analysis.Rsx"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rprofile_files() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        File::create(dir.path().join(".Rprofile"))?.sync_all()?;
        check_r_render(&dir);
        dir.close()
    }

    #[test]
    fn folder_with_rproj_user_folder() -> io::Result<()> {
        let dir = tempfile::tempdir()?;
        let rprofile = dir.path().join(".Rproj.user");
        fs::create_dir_all(&rprofile)?;
        check_r_render(&dir);
        dir.close()
    }

    fn check_r_render(dir: &tempfile::TempDir) {
        let actual = ModuleRenderer::new("rlang").path(dir.path()).collect();
        let expected = Some(format!("via {}", Color::Blue.bold().paint("📐 v4.1.0 ")));
        assert_eq!(expected, actual);
    }
}