ferro_cargo_registry_server/
name.rs1use crate::error::CargoError;
15
16pub const MAX_NAME_LEN: usize = 64;
18
19#[must_use]
21pub fn is_valid_name(name: &str) -> bool {
22 if name.is_empty() || name.len() > MAX_NAME_LEN {
23 return false;
24 }
25 let mut chars = name.chars();
26 let Some(first) = chars.next() else {
27 return false;
28 };
29 if !first.is_ascii_alphabetic() {
30 return false;
31 }
32 chars.all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_')
33}
34
35pub fn validate_name(name: &str) -> Result<(), CargoError> {
41 if is_valid_name(name) {
42 Ok(())
43 } else {
44 Err(CargoError::InvalidName(name.to_owned()))
45 }
46}
47
48#[must_use]
61pub fn canonical_name(name: &str) -> String {
62 name.to_ascii_lowercase().replace('-', "_")
63}
64
65#[must_use]
68pub fn names_collide(a: &str, b: &str) -> bool {
69 canonical_name(a) == canonical_name(b)
70}
71
72#[must_use]
85pub fn index_path(name: &str) -> String {
86 let lower = name.to_ascii_lowercase();
87 match lower.len() {
88 0 => String::new(),
89 1 => format!("1/{lower}"),
90 2 => format!("2/{lower}"),
91 3 => format!("3/{}/{}", &lower[0..1], lower),
92 _ => format!("{}/{}/{}", &lower[0..2], &lower[2..4], lower),
93 }
94}
95
96#[cfg(test)]
97mod tests {
98 use super::{index_path, is_valid_name, validate_name};
99
100 #[test]
101 fn valid_crate_names() {
102 assert!(is_valid_name("serde"));
103 assert!(is_valid_name("tokio"));
104 assert!(is_valid_name("abc-def"));
105 assert!(is_valid_name("abc_def"));
106 assert!(is_valid_name("A")); }
108
109 #[test]
110 fn invalid_crate_names() {
111 assert!(!is_valid_name(""));
112 assert!(!is_valid_name("-foo"));
113 assert!(!is_valid_name("1abc"));
114 assert!(!is_valid_name("foo bar"));
115 assert!(!is_valid_name(&"a".repeat(65)));
116 }
117
118 #[test]
122 fn name_length_boundary_is_inclusive_at_max() {
123 use super::MAX_NAME_LEN;
124 let at_max = "a".repeat(MAX_NAME_LEN);
125 assert_eq!(at_max.len(), 64);
126 assert!(is_valid_name(&at_max), "64-char name must be valid");
127 let over_max = "a".repeat(MAX_NAME_LEN + 1);
128 assert!(!is_valid_name(&over_max), "65-char name must be invalid");
129 }
130
131 #[test]
136 fn index_path_empty_name_is_empty_string() {
137 assert_eq!(index_path(""), "");
138 }
139
140 #[test]
141 fn validate_surface_error() {
142 let e = validate_name("").unwrap_err();
143 assert!(matches!(e, crate::error::CargoError::InvalidName(_)));
144 }
145
146 #[test]
147 fn index_path_layout_by_length() {
148 assert_eq!(index_path("a"), "1/a");
149 assert_eq!(index_path("ab"), "2/ab");
150 assert_eq!(index_path("abc"), "3/a/abc");
151 assert_eq!(index_path("serde"), "se/rd/serde");
152 assert_eq!(index_path("tokio"), "to/ki/tokio");
154 assert_eq!(index_path("abcd"), "ab/cd/abcd");
155 }
156
157 #[test]
158 fn index_path_lowercases() {
159 assert_eq!(index_path("Serde"), "se/rd/serde");
160 assert_eq!(index_path("AB"), "2/ab");
161 }
162
163 #[test]
166 fn canonical_name_folds_case_and_hyphen() {
167 use super::{canonical_name, names_collide};
168 assert_eq!(canonical_name("MyCrate"), "mycrate");
169 assert_eq!(canonical_name("Foo-Bar"), "foo_bar");
170 assert_eq!(canonical_name("foo_bar"), "foo_bar");
171 assert!(names_collide("foo-bar", "foo_bar"));
172 assert!(names_collide("Foo", "foo"));
173 assert!(names_collide("My-Crate", "my_crate"));
174 assert!(!names_collide("foo", "bar"));
175 }
176}