coctus 0.3.0

Command line tool for playing CodinGame puzzles and Clash of Code
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

use itertools::Itertools;
use serde::Deserialize;

use crate::stub::VariableCommand;

#[derive(Deserialize, Debug, Clone)]
#[serde(rename_all = "snake_case")]
#[allow(clippy::enum_variant_names)]
enum Casing {
    SnakeCase,
    KebabCase,
    CamelCase,
    PascalCase,
}

#[derive(Deserialize, Debug, Clone)]
#[serde(rename_all = "snake_case")]
pub struct VariableNameOptions {
    casing: Casing,
    allow_uppercase_vars: Option<bool>,
    keywords: Vec<String>,
}

fn is_uppercase_string(string: &str) -> bool {
    string.chars().all(|c| c.is_uppercase())
}

impl VariableNameOptions {
    pub(in crate::stub) fn transform_variable_name(&self, variable_name: &str) -> String {
        // CG has special treatment for variables with all uppercase identifiers.
        // In most languages they remain uppercase regardless of variable format.
        // In others (such as ruby where constants are uppercase) they get downcased.
        let converted_variable_name = match (is_uppercase_string(variable_name), self.allow_uppercase_vars) {
            (true, Some(false)) => variable_name.to_lowercase(),
            (true, _) => variable_name.to_string(),
            (false, _) => self.convert(variable_name),
        };

        self.escape_keywords(converted_variable_name)
    }

    pub(in crate::stub) fn transform_variable_command(&self, var: &VariableCommand) -> VariableCommand {
        VariableCommand {
            ident: self.transform_variable_name(&var.ident),
            var_type: var.var_type,
            input_comment: var.input_comment.clone(),
            max_length: var.max_length.as_ref().map(|s| self.transform_variable_name(s)).to_owned(),
        }
    }

    fn escape_keywords(&self, variable_name: String) -> String {
        if self.keywords.contains(&variable_name) {
            format!("_{variable_name}")
        } else {
            variable_name
        }
    }

    fn convert(&self, variable_name: &str) -> String {
        match self.casing {
            Casing::SnakeCase => Self::convert_to_snake_case(variable_name),
            Casing::KebabCase => Self::convert_to_kebab_case(variable_name),
            Casing::PascalCase => Self::convert_to_pascal_case(variable_name),
            Casing::CamelCase => Self::convert_to_camel_case(variable_name),
        }
    }

    fn ident_words(ident: &str) -> Vec<String> {
        ident
            .chars()
            .peekable()
            .batching(|char_iter| {
                char_iter.peek()?; // check if there are any chars left

                // The word boundary seem to be non-lowercase characters in CG
                // Therefore we take
                // boundary characters + lowercase characters until next boundary
                let mut word_chars: Vec<char> =
                    char_iter.peeking_take_while(|c| !c.is_ascii_lowercase()).collect();
                word_chars.extend(char_iter.peeking_take_while(|c| c.is_ascii_lowercase()));

                Some(String::from_iter(word_chars).to_lowercase())
            })
            .collect()
    }

    fn convert_to_snake_case(variable_name: &str) -> String {
        Self::ident_words(variable_name).join("_")
    }

    fn convert_to_kebab_case(variable_name: &str) -> String {
        Self::ident_words(variable_name).join("-")
    }

    fn convert_to_pascal_case(variable_name: &str) -> String {
        variable_name[0..1].to_uppercase() + &variable_name[1..]
    }

    fn convert_to_camel_case(variable_name: &str) -> String {
        variable_name[0..1].to_lowercase() + &variable_name[1..]
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_snake_case() {
        let convert = VariableNameOptions::convert_to_snake_case;
        assert_eq!("date_of_birth", convert("dateOfBirth"));
        assert_eq!("phrase_1braille_top_row", convert("Phrase1BrailleTopRow"));
        assert_eq!("crane_asciirepresentation", convert("craneASCIIRepresentation"));
    }

    #[test]
    fn test_kebab_case() {
        let convert = VariableNameOptions::convert_to_kebab_case;
        assert_eq!("date-of-birth", convert("dateOfBirth"));
        assert_eq!("phrase-1braille-top-row", convert("Phrase1BrailleTopRow"));
        assert_eq!("crane-asciirepresentation", convert("craneASCIIRepresentation"));
    }

    #[test]
    fn test_pascal_case() {
        let convert = VariableNameOptions::convert_to_pascal_case;
        assert_eq!("DateOfBirth", convert("dateOfBirth"));
        assert_eq!("Phrase1BrailleTopRow", convert("Phrase1BrailleTopRow"));
        assert_eq!("CraneASCIIRepresentation", convert("craneASCIIRepresentation"));
    }

    #[test]
    fn test_camel_case() {
        let convert = VariableNameOptions::convert_to_camel_case;
        assert_eq!("dateOfBirth", convert("dateOfBirth"));
        assert_eq!("phrase1BrailleTopRow", convert("Phrase1BrailleTopRow"));
        assert_eq!("craneASCIIRepresentation", convert("craneASCIIRepresentation"));
    }
}