poexam 0.0.9

Blazingly fast PO linter.
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

// SPDX-FileCopyrightText: 2026 Sébastien Helleu <flashcode@flashtux.org>
//
// SPDX-License-Identifier: GPL-3.0-or-later

//! Implementation of the `unchanged` rule: check unchanged translations.

use crate::checker::Checker;
use crate::diagnostic::{Diagnostic, Severity};
use crate::po::entry::Entry;
use crate::po::message::Message;
use crate::rules::rule::RuleChecker;

pub struct UnchangedRule;

impl RuleChecker for UnchangedRule {
    fn name(&self) -> &'static str {
        "unchanged"
    }

    fn is_default(&self) -> bool {
        false
    }

    fn is_check(&self) -> bool {
        true
    }

    fn severity(&self) -> Severity {
        Severity::Info
    }

    /// Check for unchanged translation: the same as the source string.
    ///
    /// If the source message contains only upper case characters, it is ignored.
    ///
    /// This rule is not enabled by default.
    ///
    /// Wrong entry:
    /// ```text
    /// msgid "this is a test"
    /// msgstr "this is a test"
    /// ```
    ///
    /// Correct entry:
    /// ```text
    /// msgid "this is a test"
    /// msgstr "ceci est un test"
    /// ```
    ///
    /// Diagnostics reported with severity [`info`](Severity::Info):
    /// - `unchanged translation`
    fn check_msg(
        &self,
        checker: &Checker,
        _entry: &Entry,
        msgid: &Message,
        msgstr: &Message,
    ) -> Vec<Diagnostic> {
        if !msgid.value.trim().is_empty()
            && !msgstr.value.trim().is_empty()
            && msgid.value == msgstr.value
        {
            let all_upper = msgid
                .value
                .chars()
                .filter(|c| c.is_alphabetic())
                .all(char::is_uppercase);
            if !all_upper && msgid.value.to_uppercase() != msgid.value {
                return vec![
                    self.new_diag(checker, "unchanged translation".to_string())
                        .with_msgs(msgid, msgstr),
                ];
            }
        }
        vec![]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{diagnostic::Diagnostic, rules::rule::Rules};

    fn check_unchanged(content: &str) -> Vec<Diagnostic> {
        let mut checker = Checker::new(content.as_bytes());
        let rules = Rules::new(vec![Box::new(UnchangedRule {})]);
        checker.do_all_checks(&rules);
        checker.diagnostics
    }

    #[test]
    fn test_not_translated() {
        let diags = check_unchanged(
            r#"
msgid "tested"
msgstr ""
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_changed() {
        let diags = check_unchanged(
            r#"
msgid "tested"
msgstr "testé"
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_unchanged_but_ok() {
        // Unchanged but considered ok (only one word).
        let diags = check_unchanged(
            r#"
msgid "ACRONYM"
msgstr "ACRONYM"
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_unchanged_error_noqa() {
        let diags = check_unchanged(
            r#"
#, noqa:unchanged
msgid "this is a test"
msgstr "this is a test"
"#,
        );
        assert!(diags.is_empty());
    }

    #[test]
    fn test_unchanged_error() {
        let diags = check_unchanged(
            r#"
msgid "this is a test"
msgstr "this is a test"
"#,
        );
        assert_eq!(diags.len(), 1);
        let diag = &diags[0];
        assert_eq!(diag.severity, Severity::Info);
        assert_eq!(diag.message, "unchanged translation");
    }
}