| 1 | //! Greetings. |
| 2 | |
| 3 | /// A supported greeting language. |
| 4 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] |
| 5 | pub enum Lang { |
| 6 | #[default] |
| 7 | En, |
| 8 | Es, |
| 9 | Fr, |
| 10 | } |
| 11 | |
| 12 | impl Lang { |
| 13 | /// Parses a language code (`en`, `es` or `fr`). |
| 14 | pub fn parse(code: &str) -> Option<Lang> { |
| 15 | match code { |
| 16 | "en" => Some(Lang::En), |
| 17 | "es" => Some(Lang::Es), |
| 18 | "fr" => Some(Lang::Fr), |
| 19 | _ => None, |
| 20 | } |
| 21 | } |
| 22 | } |
| 23 | |
| 24 | /// Parsed command-line options. |
| 25 | #[derive(Debug, PartialEq, Eq)] |
| 26 | pub struct Options { |
| 27 | /// The name to greet, if one was given. |
| 28 | pub name: Option<String>, |
| 29 | /// Whether to upper-case the greeting (`--shout`). |
| 30 | pub shout: bool, |
| 31 | /// Whether to print the crate version and exit (`--version`). |
| 32 | pub version: bool, |
| 33 | /// How many times to print the greeting (`--times N`). |
| 34 | pub times: usize, |
| 35 | /// The greeting language (`--lang CODE`). |
| 36 | pub lang: Lang, |
| 37 | /// Whether to print nothing (`--quiet`). |
| 38 | pub quiet: bool, |
| 39 | /// Whether to end the greeting with three exclamation marks (`--loud`). |
| 40 | pub loud: bool, |
| 41 | /// Whether to print a goodbye after the greeting (`--bye`). |
| 42 | pub bye: bool, |
| 43 | } |
| 44 | |
| 45 | impl Default for Options { |
| 46 | fn default() -> Self { |
| 47 | Options { |
| 48 | name: None, |
| 49 | shout: false, |
| 50 | version: false, |
| 51 | times: 1, |
| 52 | lang: Lang::En, |
| 53 | quiet: false, |
| 54 | loud: false, |
| 55 | bye: false, |
| 56 | } |
| 57 | } |
| 58 | } |
| 59 | |
| 60 | /// Parses command-line arguments (excluding the program name). |
| 61 | /// |
| 62 | /// `--shout` sets [`Options::shout`], `--version` sets |
| 63 | /// [`Options::version`], and `--times N` sets [`Options::times`] (the |
| 64 | /// next argument is consumed as the value), and `--lang CODE` sets |
| 65 | /// [`Options::lang`] (likewise consuming the next argument); other |
| 66 | /// arguments starting with `--` are treated as flags and skipped. The |
| 67 | /// name is the first remaining argument. |
| 68 | /// |
| 69 | /// Returns an error message if `--times` has a missing or non-numeric |
| 70 | /// value, or if `--lang` has a missing or unsupported value. |
| 71 | pub fn parse_args<I: IntoIterator<Item = String>>(args: I) -> Result<Options, String> { |
| 72 | let mut options = Options::default(); |
| 73 | let mut args = args.into_iter(); |
| 74 | while let Some(arg) = args.next() { |
| 75 | if arg == "--shout" { |
| 76 | options.shout = true; |
| 77 | } else if arg == "--version" { |
| 78 | options.version = true; |
| 79 | } else if arg == "--quiet" { |
| 80 | options.quiet = true; |
| 81 | } else if arg == "--loud" || arg == "-L" { |
| 82 | options.loud = true; |
| 83 | } else if arg == "--bye" { |
| 84 | options.bye = true; |
| 85 | } else if arg == "--times" { |
| 86 | let value = args |
| 87 | .next() |
| 88 | .ok_or_else(|| "--times requires a value".to_owned())?; |
| 89 | options.times = value |
| 90 | .parse() |
| 91 | .map_err(|_| format!("--times value must be a number, got {value:?}"))?; |
| 92 | } else if arg == "--lang" { |
| 93 | let value = args |
| 94 | .next() |
| 95 | .ok_or_else(|| "--lang requires a value".to_owned())?; |
| 96 | options.lang = Lang::parse(&value).ok_or_else(|| { |
| 97 | format!("--lang value must be one of en, es, fr, got {value:?}") |
| 98 | })?; |
| 99 | } else if !arg.starts_with("--") && options.name.is_none() { |
| 100 | options.name = Some(arg); |
| 101 | } |
| 102 | } |
| 103 | Ok(options) |
| 104 | } |
| 105 | |
| 106 | /// `text` upper-cased. |
| 107 | pub fn shout(text: &str) -> String { |
| 108 | text.to_uppercase() |
| 109 | } |
| 110 | |
| 111 | /// `text` with its final exclamation mark replaced by three. |
| 112 | pub fn loud(text: &str) -> String { |
| 113 | format!("{}!!!", text.strip_suffix('!').unwrap_or(text)) |
| 114 | } |
| 115 | |
| 116 | /// The greeting for `name`. |
| 117 | pub fn hail(name: &str) -> String { |
| 118 | greeting_in(name, Lang::En) |
| 119 | } |
| 120 | |
| 121 | /// The greeting for `name` in `lang`. |
| 122 | pub fn greeting_in(name: &str, lang: Lang) -> String { |
| 123 | let trimmed = name.trim(); |
| 124 | let display_name = if trimmed.is_empty() { "world" } else { trimmed }; |
| 125 | match lang { |
| 126 | Lang::En => format!("Hi, {display_name}!"), |
| 127 | Lang::Es => format!("¡Hola, {display_name}!"), |
| 128 | Lang::Fr => format!("Bonjour, {display_name} !"), |
| 129 | } |
| 130 | } |
| 131 | |
| 132 | /// The farewell for `name`. |
| 133 | pub fn part(name: &str) -> String { |
| 134 | let trimmed = name.trim(); |
| 135 | let display_name = if trimmed.is_empty() { "world" } else { trimmed }; |
| 136 | format!("Goodbye, {display_name}!") |
| 137 | } |
| 138 | |
| 139 | #[cfg(test)] |
| 140 | mod tests { |
| 141 | use super::*; |
| 142 | |
| 143 | fn args(list: &[&str]) -> Vec<String> { |
| 144 | list.iter().map(|s| s.to_string()).collect() |
| 145 | } |
| 146 | |
| 147 | #[test] |
| 148 | fn parse_args_quiet() { |
| 149 | assert!(parse_args(args(&["--quiet", "Ada"])).unwrap().quiet); |
| 150 | assert!(!parse_args(args(&["Ada"])).unwrap().quiet); |
| 151 | } |
| 152 | |
| 153 | #[test] |
| 154 | fn parse_args_bye() { |
| 155 | assert!(parse_args(args(&["--bye", "Ada"])).unwrap().bye); |
| 156 | assert!(!parse_args(args(&["Ada"])).unwrap().bye); |
| 157 | } |
| 158 | |
| 159 | #[test] |
| 160 | fn parse_args_loud() { |
| 161 | assert!(parse_args(args(&["--loud", "Ada"])).unwrap().loud); |
| 162 | assert!(parse_args(args(&["-L", "Ada"])).unwrap().loud); |
| 163 | assert!(!parse_args(args(&["Ada"])).unwrap().loud); |
| 164 | } |
| 165 | |
| 166 | #[test] |
| 167 | fn loud_uses_three_exclamation_marks() { |
| 168 | assert_eq!(loud(&hail("Ada")), "Hi, Ada!!!"); |
| 169 | } |
| 170 | |
| 171 | #[test] |
| 172 | fn parse_args_no_args() { |
| 173 | assert_eq!(parse_args(args(&[])).unwrap().name, None); |
| 174 | } |
| 175 | |
| 176 | #[test] |
| 177 | fn parse_args_name() { |
| 178 | assert_eq!(parse_args(args(&["Ada"])).unwrap().name.as_deref(), Some("Ada")); |
| 179 | } |
| 180 | |
| 181 | #[test] |
| 182 | fn parse_args_skips_leading_flag() { |
| 183 | assert_eq!( |
| 184 | parse_args(args(&["--unknown", "Ada"])).unwrap().name.as_deref(), |
| 185 | Some("Ada") |
| 186 | ); |
| 187 | } |
| 188 | |
| 189 | #[test] |
| 190 | fn parse_args_shout_defaults_off() { |
| 191 | assert!(!parse_args(args(&["Ada"])).unwrap().shout); |
| 192 | } |
| 193 | |
| 194 | #[test] |
| 195 | fn parse_args_shout_before_name() { |
| 196 | let options = parse_args(args(&["--shout", "Ada"])).unwrap(); |
| 197 | assert!(options.shout); |
| 198 | assert_eq!(options.name.as_deref(), Some("Ada")); |
| 199 | } |
| 200 | |
| 201 | #[test] |
| 202 | fn parse_args_shout_after_name() { |
| 203 | let options = parse_args(args(&["Ada", "--shout"])).unwrap(); |
| 204 | assert!(options.shout); |
| 205 | assert_eq!(options.name.as_deref(), Some("Ada")); |
| 206 | } |
| 207 | |
| 208 | #[test] |
| 209 | fn parse_args_shout_alone() { |
| 210 | let options = parse_args(args(&["--shout"])).unwrap(); |
| 211 | assert!(options.shout); |
| 212 | assert_eq!(options.name, None); |
| 213 | } |
| 214 | |
| 215 | #[test] |
| 216 | fn parse_args_version_defaults_off() { |
| 217 | assert!(!parse_args(args(&["Ada"])).unwrap().version); |
| 218 | } |
| 219 | |
| 220 | #[test] |
| 221 | fn parse_args_version() { |
| 222 | let options = parse_args(args(&["--version"])).unwrap(); |
| 223 | assert!(options.version); |
| 224 | assert_eq!(options.name, None); |
| 225 | } |
| 226 | |
| 227 | #[test] |
| 228 | fn parse_args_times_defaults_to_one() { |
| 229 | assert_eq!(parse_args(args(&["Ada"])).unwrap().times, 1); |
| 230 | } |
| 231 | |
| 232 | #[test] |
| 233 | fn parse_args_times_valid() { |
| 234 | let options = parse_args(args(&["--times", "3", "Ada"])).unwrap(); |
| 235 | assert_eq!(options.times, 3); |
| 236 | assert_eq!(options.name.as_deref(), Some("Ada")); |
| 237 | } |
| 238 | |
| 239 | #[test] |
| 240 | fn parse_args_times_missing_value() { |
| 241 | assert!(parse_args(args(&["--times"])).is_err()); |
| 242 | } |
| 243 | |
| 244 | #[test] |
| 245 | fn parse_args_times_non_number() { |
| 246 | assert!(parse_args(args(&["--times", "abc", "Ada"])).is_err()); |
| 247 | } |
| 248 | |
| 249 | #[test] |
| 250 | fn parse_args_lang_defaults_to_en() { |
| 251 | assert_eq!(parse_args(args(&["Ada"])).unwrap().lang, Lang::En); |
| 252 | } |
| 253 | |
| 254 | #[test] |
| 255 | fn parse_args_lang_valid() { |
| 256 | let options = parse_args(args(&["--lang", "es", "Ana"])).unwrap(); |
| 257 | assert_eq!(options.lang, Lang::Es); |
| 258 | assert_eq!(options.name.as_deref(), Some("Ana")); |
| 259 | assert_eq!(parse_args(args(&["--lang", "fr"])).unwrap().lang, Lang::Fr); |
| 260 | } |
| 261 | |
| 262 | #[test] |
| 263 | fn parse_args_lang_missing_value() { |
| 264 | assert_eq!( |
| 265 | parse_args(args(&["--lang"])).unwrap_err(), |
| 266 | "--lang requires a value" |
| 267 | ); |
| 268 | } |
| 269 | |
| 270 | #[test] |
| 271 | fn parse_args_lang_unknown() { |
| 272 | assert_eq!( |
| 273 | parse_args(args(&["--lang", "de"])).unwrap_err(), |
| 274 | "--lang value must be one of en, es, fr, got \"de\"" |
| 275 | ); |
| 276 | } |
| 277 | |
| 278 | #[test] |
| 279 | fn greeting_in_each_language() { |
| 280 | assert_eq!(greeting_in("Ada", Lang::En), "Hi, Ada!"); |
| 281 | assert_eq!(greeting_in("Ana", Lang::Es), "¡Hola, Ana!"); |
| 282 | assert_eq!(greeting_in("Luc", Lang::Fr), "Bonjour, Luc !"); |
| 283 | } |
| 284 | |
| 285 | #[test] |
| 286 | fn greeting_in_trims_and_falls_back_to_world() { |
| 287 | assert_eq!(greeting_in(" Ana ", Lang::Es), "¡Hola, Ana!"); |
| 288 | assert_eq!(greeting_in(" ", Lang::Fr), "Bonjour, world !"); |
| 289 | } |
| 290 | |
| 291 | #[test] |
| 292 | fn shout_upper_cases_greeting() { |
| 293 | assert_eq!(shout(&hail("Ada")), "HI, ADA!"); |
| 294 | } |
| 295 | |
| 296 | #[test] |
| 297 | fn greets_by_name() { |
| 298 | assert_eq!(hail("Ada"), "Hi, Ada!"); |
| 299 | } |
| 300 | |
| 301 | #[test] |
| 302 | fn greets_world_with_empty_string() { |
| 303 | assert_eq!(hail(""), "Hi, world!"); |
| 304 | } |
| 305 | |
| 306 | #[test] |
| 307 | fn greets_world_with_whitespace_only() { |
| 308 | assert_eq!(hail(" "), "Hi, world!"); |
| 309 | } |
| 310 | |
| 311 | #[test] |
| 312 | fn trims_whitespace_from_name() { |
| 313 | assert_eq!(hail(" Ada "), "Hi, Ada!"); |
| 314 | } |
| 315 | |
| 316 | #[test] |
| 317 | fn says_goodbye_by_name() { |
| 318 | assert_eq!(part("Ada"), "Goodbye, Ada!"); |
| 319 | } |
| 320 | |
| 321 | #[test] |
| 322 | fn says_goodbye_to_world_when_blank() { |
| 323 | assert_eq!(part(" "), "Goodbye, world!"); |
| 324 | } |
| 325 | |
| 326 | #[test] |
| 327 | fn farewell_trims_whitespace() { |
| 328 | assert_eq!(part(" Ada "), "Goodbye, Ada!"); |
| 329 | } |
| 330 | } |