aboutsummaryrefslogtreecommitdiff
path: root/heck/src/snake.rs
diff options
context:
space:
mode:
Diffstat (limited to 'heck/src/snake.rs')
-rw-r--r--heck/src/snake.rs79
1 files changed, 79 insertions, 0 deletions
diff --git a/heck/src/snake.rs b/heck/src/snake.rs
new file mode 100644
index 0000000..86c3756
--- /dev/null
+++ b/heck/src/snake.rs
@@ -0,0 +1,79 @@
+/// This trait defines a camel case conversion.
+///
+/// In snake_case, word boundaries are indicated by underscores.
+///
+/// ## Example:
+///
+/// ```rust
+/// extern crate heck;
+/// fn main() {
+///
+/// use heck::SnakeCase;
+///
+/// let sentence = "We carry a new world here, in our hearts.";
+/// assert_eq!(sentence.to_snake_case(), "we_carry_a_new_world_here_in_our_hearts");
+/// }
+/// ```
+pub trait SnakeCase: ToOwned {
+ /// Convert this type to snake case.
+ fn to_snake_case(&self) -> Self::Owned;
+}
+
+/// Oh heck, SnekCase is an alias for SnakeCase. See SnakeCase for
+/// more documentation.
+pub trait SnekCase: ToOwned {
+ /// Convert this type to snek case.
+ fn to_snek_case(&self) -> Self::Owned;
+}
+
+impl<T: ?Sized + SnakeCase> SnekCase for T {
+ fn to_snek_case(&self) -> Self::Owned {
+ self.to_snake_case()
+ }
+}
+
+impl SnakeCase for str {
+ fn to_snake_case(&self) -> String {
+ ::transform(self, ::lowercase, |s| s.push('_'))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::SnakeCase;
+
+ macro_rules! t {
+ ($t:ident : $s1:expr => $s2:expr) => {
+ #[test]
+ fn $t() {
+ assert_eq!($s1.to_snake_case(), $s2)
+ }
+ }
+ }
+
+ t!(test1: "CamelCase" => "camel_case");
+ t!(test2: "This is Human case." => "this_is_human_case");
+ t!(test3: "MixedUP CamelCase, with some Spaces" => "mixed_up_camel_case_with_some_spaces");
+ t!(test4: "mixed_up_ snake_case with some _spaces" => "mixed_up_snake_case_with_some_spaces");
+ t!(test5: "kebab-case" => "kebab_case");
+ t!(test6: "SHOUTY_SNAKE_CASE" => "shouty_snake_case");
+ t!(test7: "snake_case" => "snake_case");
+ t!(test8: "this-contains_ ALLKinds OfWord_Boundaries" => "this_contains_all_kinds_of_word_boundaries");
+ t!(test9: "XΣXΣ baffle" => "xσxς_baffle");
+ t!(test10: "XMLHttpRequest" => "xml_http_request");
+ t!(test11: "FIELD_NAME11" => "field_name11");
+ t!(test12: "99BOTTLES" => "99bottles");
+ t!(test13: "FieldNamE11" => "field_nam_e11");
+
+ t!(test14: "abc123def456" => "abc123def456");
+ t!(test16: "abc123DEF456" => "abc123_def456");
+ t!(test17: "abc123Def456" => "abc123_def456");
+ t!(test18: "abc123DEf456" => "abc123_d_ef456");
+ t!(test19: "ABC123def456" => "abc123def456");
+ t!(test20: "ABC123DEF456" => "abc123def456");
+ t!(test21: "ABC123Def456" => "abc123_def456");
+ t!(test22: "ABC123DEf456" => "abc123d_ef456");
+ t!(test23: "ABC123dEEf456FOO" => "abc123d_e_ef456_foo");
+ t!(test24: "abcDEF" => "abc_def");
+ t!(test25: "ABcDE" => "a_bc_de");
+}