fortitude 0.3.0

A Fortran linter, written in Rust and installable with Python
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

use crate::settings::Settings;
use crate::violation;
use crate::{PathRule, Rule, Violation};
use std::path::Path;
/// Defines rule that enforces use of standard file extensions.

pub struct NonStandardFileExtension {}

impl Rule for NonStandardFileExtension {
    fn new(_settings: &Settings) -> Self {
        NonStandardFileExtension {}
    }

    fn explain(&self) -> &'static str {
        "
        The standard file extensions for modern (free-form) Fortran are '.f90' or  '.F90'.
        Forms that reference later Fortran standards such as '.f08' or '.F95' may be rejected
        by some compilers and build tools.
        "
    }
}

impl PathRule for NonStandardFileExtension {
    fn check(&self, path: &Path) -> Option<Violation> {
        let msg: &str = "file extension should be '.f90' or '.F90'";
        match path.extension() {
            Some(ext) => {
                // Must check like this as ext is an OsStr
                if ["f90", "F90"].iter().any(|&x| x == ext) {
                    None
                } else {
                    Some(violation!(msg))
                }
            }
            None => Some(violation!(msg)),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::settings::default_settings;
    use crate::violation;

    #[test]
    fn test_bad_file_extension() {
        let path = Path::new("my/dir/to/file.f95");
        let rule = NonStandardFileExtension::new(&default_settings());
        assert_eq!(
            rule.check(path),
            Some(violation!["file extension should be '.f90' or '.F90'"]),
        );
    }

    #[test]
    fn test_missing_file_extension() {
        let path = Path::new("my/dir/to/file");
        let rule = NonStandardFileExtension::new(&default_settings());
        assert_eq!(
            rule.check(path),
            Some(violation!["file extension should be '.f90' or '.F90'"]),
        );
    }

    #[test]
    fn test_correct_file_extensions() {
        let path1 = Path::new("my/dir/to/file.f90");
        let path2 = Path::new("my/dir/to/file.F90");
        let rule = NonStandardFileExtension::new(&default_settings());
        assert_eq!(rule.check(path1), None);
        assert_eq!(rule.check(path2), None);
    }
}