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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

#[allow(non_camel_case_types)]
pub enum Convention{
    /// sanename-package naming convention
    sanename,
    /// JavaClassName naming convention
    ClassCase,
    /// camelCase with lowercase first word naming convention
    camelCase,
    /// CONSTANT_CASE name convention
    CONSTANT_CASE,
    /// kernel_case, aka snake_case naming conventions
    snake_case
}

/// Validate a sanename package name
pub fn validate(name: &str) -> bool {
	validate_sanename(name)
}

/// Validate a sanename package name format i.e. `[a-z][a-z0-9]*(-[a-z][a-z0-9]*)*`
/// e.g. `sanename-package2`
pub fn validate_sanename(name: &str) -> bool {
    let mut was_dash= false;
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_lowercase() {
            return false;
        } else if ch == '-' {
            if was_dash {
                return false;
            }
            was_dash = true;
        } else if ! ch.is_ascii_lowercase() && ! ch.is_ascii_digit() {
            return false;
        } else {
            was_dash = false;
        }
    }
    true
}

/// Validate a single word in a sanename, i.e. no dashes for separating words.
/// e.g. `sanename`
pub fn validate_sanename_word(name: &str) -> bool {
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_lowercase() {
            return false;
        } else if ! ch.is_ascii_lowercase() && ! ch.is_ascii_digit() {
            return false;
        }
    }
    true
}

/// Validate CamelCase: with leading uppercase letter.
/// e.g. `SanenamePackage2`
pub fn validate_class_name(name: &str) -> bool {
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_uppercase() {
            return false;
        } else if ! ch.is_ascii_alphanumeric() {
            return false;
        }
    }
    true
}

/// Validate camelCase: with lowercase leading letter.
/// e.g. `sanenamePackage2`
pub fn validate_camel_case(name: &str) -> bool {
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_lowercase() {
            return false;
        } else if ! ch.is_ascii_alphanumeric() {
            return false;
        }
    }
    true
}

/// Validate CONSTANT_CASE: uppercase separated by underscore
/// e.g. `SANENAME_PACKAGE2`
pub fn validate_constant(name: &str) -> bool {
    let mut was_underscore = false;
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_uppercase() {
            return false;
        } else if ch == '_' {
            if was_underscore {
                return false;
            }
            was_underscore = true;
        } else if ! ch.is_ascii_uppercase()  && ! ch.is_ascii_digit() {
            return false;
        } else {
            was_underscore = false
        }
    }
    true
}

/// Validate kernel_case: lowercase separated by underscore
/// e.g. `sanename_package2`
pub fn validate_snake_case(name: &str) -> bool {
    let mut was_underscore = false;
    for (i, ch) in name.chars().enumerate() {
        if i == 0 && !ch.is_ascii_lowercase() {
            return false;
        } else if ch == '_' {
            if was_underscore {
                return false;
            }
            was_underscore = true;
        } else if ! ch.is_ascii_lowercase() && ! ch.is_ascii_digit() {
            return false;
        } else {
            was_underscore = false
        }
    }
    true
}

/// sanenames should be 3 - 32 chars, validation of this is optional.
pub fn validate_len(name: &str) -> bool {
    let len = name.len();
    len >= 3 && len <= 32
}

/// Convert a package-name format string to another naming convention.
///
/// `name` - assume to already be sanename-package
///
/// returns a String following the specified naming convention, in input is invalid output is undefined.
pub fn convert_to(name: &str, c: Convention) -> String {
    let mut was_dash = false;
    let mut s = String::with_capacity(name.len() + 4);
    match c {
        Convention::camelCase => {
            for ch in name.chars() {
                if ch == '-' || ch == '_' {
                    was_dash = true;
                    continue;
                }
                if was_dash {
                    s.push(ch.to_ascii_uppercase());
                } else {
                    s.push(ch.to_ascii_lowercase());
                }
                was_dash = false;
            }
        },
        Convention::ClassCase => {
            for (i, ch) in name.chars().enumerate() {
                if i == 0 || was_dash {
                    s.push(ch.to_ascii_uppercase());
                    was_dash = false;
                    continue;
                }
                if ch == '-' || ch == '_' {
                    was_dash = true;
                    continue;
                }
                s.push(ch.to_ascii_lowercase());
                was_dash = false;
            }
        },
        Convention::CONSTANT_CASE => {
            for ch in name.chars() {
                if ch == '-' || ch == '_' {
                    s.push('_');
                } else {
                    s.push(ch.to_ascii_uppercase());
                }
            }
        },
        Convention::snake_case => {
            for ch in name.chars() {
                if ch == '-' || ch == '_' {
                    s.push('_');
                } else {
                    s.push(ch);
                }
            }
        },
        Convention::sanename => {
            s = name.to_string();
        }
    }

    s
}

/// Convert a string with another naming convention to sanename-package convention.
///
/// `name` - assumed to already be correctly formatted
pub fn convert_from(name: &str, c: Convention) -> String {
    let mut s = String::with_capacity(name.len() + 4);
    match c {
        Convention::camelCase => {
            for ch in name.chars() {
                if ch.is_ascii_uppercase() {
                    s.push('-');
                }
                s.push(ch.to_ascii_lowercase());
            }
        },
        Convention::ClassCase => {
            for (i, ch) in name.chars().enumerate() {
                if i > 0 && ch.is_ascii_uppercase() {
                    s.push('-');
                }
                s.push(ch.to_ascii_lowercase());
            }
        },
        Convention::CONSTANT_CASE => {
            for ch in name.chars() {
                if ch == '_' {
                    s.push('-');
                }
                else {
                    s.push(ch.to_ascii_lowercase());
                }
            }
        },
        Convention::snake_case => {
            for ch in name.chars() {
                if ch == '_' {
                    s.push('-');
                } else {
                    s.push(ch);
                }
            }
        },
        Convention::sanename => {
            s = name.to_string();
        }
    }

    s
}

/// Takes a String in any format and returns sanename-package format discarding stuff sanename
/// does not approve of.  Implicit trimming of whitespace.
/// Common delimiters are converted to at most one sequential -
pub fn sanitize(name: &str) -> String {
    let mut s = String::with_capacity(name.len() + 4);
    let mut start = true;
    let mut was_delim = false;
    for ch in name.chars() {
        if start && (ch.is_ascii_digit() || ! ch.is_ascii_alphabetic()) {
            continue;
        }
        start = false;
        if ch.is_ascii_alphanumeric() {
            s.push(ch.to_ascii_lowercase());
            was_delim = false;
        }
        if !was_delim &&
            (
           ch == '-' ||
           ch == '_' ||
           ch == '+' ||
           ch == ' ' ||
           ch == '/' ||
           ch == '.' ||
           ch == '\\' ||
           ch == '|'
            ) {
            s.push('-');
            was_delim = true;
        }
    }
    s = String::from(s.trim_end_matches('-'));

    s
}

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

    #[test]
    fn test_happy_path() {
        assert!(validate("sanename-package1"));
        assert!(validate_sanename_word("sanename"));
        assert!(validate_snake_case("sanename_package1"));
        assert!(validate_camel_case("sanenamePackage1"));
        assert!(validate_class_name("SanenamePackage1"));
        assert!(validate_constant("SANENAME_PACKAGE1"));

        assert_eq!("sanename-package1", convert_to("sanename-package1", Convention::sanename).as_str());
        assert_eq!("sanename_package1", convert_to("sanename-package1", Convention::snake_case).as_str());
        assert_eq!("sanenamePackage1", convert_to("sanename-package1", Convention::camelCase).as_str());
        assert_eq!("SanenamePackage1", convert_to("sanename-package1", Convention::ClassCase).as_str());
        assert_eq!("SANENAME_PACKAGE1", convert_to("sanename-package1", Convention::CONSTANT_CASE).as_str());

        assert_eq!("sanename-package1", convert_from("sanename-package1", Convention::sanename).as_str());
        assert_eq!("sanename-package1", convert_from("sanename_package1", Convention::snake_case).as_str());
        assert_eq!("sanename-package1", convert_from("sanenamePackage1", Convention::camelCase).as_str());
        assert_eq!("sanename-package1", convert_from("SanenamePackage1", Convention::ClassCase).as_str());
        assert_eq!("sanename-package1", convert_from("SANENAME_PACKAGE1", Convention::CONSTANT_CASE).as_str());
    }


    /// single digit words are allowed
    #[test]
    fn test_single_digit_words() {
        assert!(validate("sanename-a-package1"));
        assert!(validate_snake_case("sanename_a_package1"));
        assert!(validate_camel_case("sanenameAPackage1"));
        assert!(validate_class_name("SanenameAPackage1"));
        assert!(validate_constant("SANENAME_A_PACKAGE1"));

        assert_eq!("sanename-a-package1", convert_to("sanename-a-package1", Convention::sanename).as_str());
        assert_eq!("sanename_a_package1", convert_to("sanename-a-package1", Convention::snake_case).as_str());
        assert_eq!("sanenameAPackage1", convert_to("sanename-a-package1", Convention::camelCase).as_str());
        assert_eq!("SanenameAPackage1", convert_to("sanename-a-package1", Convention::ClassCase).as_str());
        assert_eq!("SANENAME_A_PACKAGE1", convert_to("sanename-a-package1", Convention::CONSTANT_CASE).as_str());

        assert_eq!("sanename-a-package1", convert_from("sanename-a-package1", Convention::sanename).as_str());
        assert_eq!("sanename-a-package1", convert_from("sanename_a_package1", Convention::snake_case).as_str());
        assert_eq!("sanename-a-package1", convert_from("sanenameAPackage1", Convention::camelCase).as_str());
        assert_eq!("sanename-a-package1", convert_from("SanenameAPackage1", Convention::ClassCase).as_str());
        assert_eq!("sanename-a-package1", convert_from("SANENAME_A_PACKAGE1", Convention::CONSTANT_CASE).as_str());
    }

    #[test]
    fn test_two_way_conversion() {
        let test = "sanename-a-package1";

        let converted = convert_to(test, Convention::CONSTANT_CASE);
        let back = convert_from(converted.as_str(), Convention::CONSTANT_CASE);
        assert_eq!(test, back);

        let converted = convert_to(test, Convention::ClassCase);
        let back = convert_from(converted.as_str(), Convention::ClassCase);
        assert_eq!(test, back);

        let converted = convert_to(test, Convention::camelCase);
        let back = convert_from(converted.as_str(), Convention::camelCase);
        assert_eq!(test, back);

        let converted = convert_to(test, Convention::snake_case);
        let back = convert_from(converted.as_str(), Convention::snake_case);
        assert_eq!(test, back);
    }

    #[test]
    fn test_validate_negs() {
        // leading digits not allowed
        assert!(!validate("1sanename-package1"));
        assert!(!validate_sanename_word("sanename-wrong"));
        assert!(!validate_snake_case("1sanename_package1"));
        assert!(!validate_camel_case("1sanenamePackage1"));
        assert!(!validate_class_name("1SanenamePackage1"));
        assert!(!validate_constant("1SANENAME_PACKAGE1"));
    }


    #[test]
    fn test_sanitize() {
        assert_eq!("sanename-a-package1", sanitize("-000Sane$naMe----A Pack*age1@$%---"));
        /// assert trims
        assert_eq!("sanename-a-package1", sanitize(" sanename-a-package1 "));
        assert_eq!("sanename-a-package1", sanitize(" sanename-a-package1\0"));
        assert_eq!("sanename-a-package1", sanitize("sanename-a-package1\n"));
        assert_eq!("sanename-a-package1", sanitize("sanename-a-package1\t"));
    }
}