ferrocat-po 0.10.0

Performance-first PO parsing, serialization, and catalog update primitives for ferrocat.
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

mod catalog;
mod compile;
mod compile_types;
mod file_io;
mod helpers;
mod ndjson;
mod plural;
mod types;

pub use self::catalog::{combine_catalogs, parse_catalog, update_catalog, update_catalog_file};
pub use self::compile::{
    compile_catalog_artifact, compile_catalog_artifact_selected, compiled_key,
};
pub use self::compile_types::{
    CompileCatalogArtifactOptions, CompileCatalogOptions, CompileSelectedCatalogArtifactOptions,
    CompiledCatalog, CompiledCatalogArtifact, CompiledCatalogDiagnostic,
    CompiledCatalogIdDescription, CompiledCatalogIdIndex, CompiledCatalogMissingMessage,
    CompiledCatalogTranslationKind, CompiledCatalogUnavailableId, CompiledKeyStrategy,
    CompiledMessage, CompiledTranslation, DescribeCompiledIdsReport,
};
pub use self::types::{
    ApiError, CatalogCombineInput, CatalogCombineResult, CatalogCombineSelection,
    CatalogCombineStats, CatalogConflictStrategy, CatalogMessage, CatalogMessageExtra,
    CatalogMessageKey, CatalogOrigin, CatalogSemantics, CatalogStats, CatalogStorageFormat,
    CatalogUpdateInput, CatalogUpdateResult, CombineCatalogOptions, Diagnostic, DiagnosticSeverity,
    EffectiveTranslation, EffectiveTranslationRef, ExtractedMessage, ExtractedPluralMessage,
    ExtractedSingularMessage, NormalizedParsedCatalog, ObsoleteStrategy, OrderBy,
    ParseCatalogOptions, ParsedCatalog, PlaceholderCommentMode, PluralEncoding, PluralSource,
    SourceExtractedMessage, TranslationShape, UpdateCatalogFileOptions, UpdateCatalogOptions,
};

fn validate_source_locale(source_locale: &str) -> Result<(), ApiError> {
    if source_locale.trim().is_empty() {
        return Err(ApiError::InvalidArguments(
            "source_locale must not be empty".to_owned(),
        ));
    }
    Ok(())
}

fn validate_catalog_semantics(
    semantics: CatalogSemantics,
    storage_format: CatalogStorageFormat,
    plural_encoding: PluralEncoding,
) -> Result<(), ApiError> {
    match semantics {
        CatalogSemantics::IcuNative if plural_encoding != PluralEncoding::Icu => {
            Err(ApiError::InvalidArguments(
                "CatalogSemantics::IcuNative requires PluralEncoding::Icu".to_owned(),
            ))
        }
        CatalogSemantics::GettextCompat if plural_encoding != PluralEncoding::Gettext => {
            Err(ApiError::InvalidArguments(
                "CatalogSemantics::GettextCompat requires PluralEncoding::Gettext".to_owned(),
            ))
        }
        CatalogSemantics::GettextCompat if storage_format == CatalogStorageFormat::Ndjson => {
            Err(ApiError::Unsupported(
                "CatalogSemantics::GettextCompat is not supported for NDJSON catalogs".to_owned(),
            ))
        }
        _ => Ok(()),
    }
}

#[cfg(test)]
mod unit_tests {
    use super::{
        ApiError, CatalogSemantics, CatalogStorageFormat, PluralEncoding,
        validate_catalog_semantics, validate_source_locale,
    };

    #[test]
    fn validate_source_locale_rejects_empty_values() {
        assert!(validate_source_locale("en").is_ok());
        assert!(validate_source_locale(" en ").is_ok());
        assert!(matches!(
            validate_source_locale(" \n\t "),
            Err(ApiError::InvalidArguments(message)) if message.contains("must not be empty")
        ));
    }

    #[test]
    fn validate_catalog_semantics_accepts_only_supported_combinations() {
        assert!(
            validate_catalog_semantics(
                CatalogSemantics::IcuNative,
                CatalogStorageFormat::Po,
                PluralEncoding::Icu
            )
            .is_ok()
        );
        assert!(
            validate_catalog_semantics(
                CatalogSemantics::IcuNative,
                CatalogStorageFormat::Ndjson,
                PluralEncoding::Icu
            )
            .is_ok()
        );
        assert!(
            validate_catalog_semantics(
                CatalogSemantics::GettextCompat,
                CatalogStorageFormat::Po,
                PluralEncoding::Gettext
            )
            .is_ok()
        );

        assert!(matches!(
            validate_catalog_semantics(
                CatalogSemantics::IcuNative,
                CatalogStorageFormat::Po,
                PluralEncoding::Gettext
            ),
            Err(ApiError::InvalidArguments(message))
                if message.contains("IcuNative requires PluralEncoding::Icu")
        ));
        assert!(matches!(
            validate_catalog_semantics(
                CatalogSemantics::GettextCompat,
                CatalogStorageFormat::Po,
                PluralEncoding::Icu
            ),
            Err(ApiError::InvalidArguments(message))
                if message.contains("GettextCompat requires PluralEncoding::Gettext")
        ));
        assert!(matches!(
            validate_catalog_semantics(
                CatalogSemantics::GettextCompat,
                CatalogStorageFormat::Ndjson,
                PluralEncoding::Gettext
            ),
            Err(ApiError::Unsupported(message))
                if message.contains("not supported for NDJSON")
        ));
    }
}

#[cfg(test)]
mod tests;