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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
use crate::{Action, ActionResult, ActionWithResult, Context, Flag, FlagType, Help};
/// Application command type
#[derive(Default)]
pub struct Command {
/// Command name
pub name: String,
/// Command description
pub description: Option<String>,
/// Command usage
pub usage: Option<String>,
/// Command action
pub action: Option<Action>,
/// Alternate command action that returns a Result
pub action_with_result: Option<ActionWithResult>,
/// Action flags
pub flags: Option<Vec<Flag>>,
/// Command alias
pub alias: Option<Vec<String>>,
pub commands: Option<Vec<Command>>,
}
impl Command {
/// Create new instance of `Command`
///
/// Example
///
/// ```
/// use seahorse::Command;
///
/// let command = Command::new("cmd");
/// ```
pub fn new<T: Into<String>>(name: T) -> Self {
Self {
name: name.into(),
..Self::default()
}
}
/// Set description of the command
///
/// Example
///
/// ```
/// use seahorse::Command;
///
/// let command = Command::new("cmd")
/// .description("cli sub command");
/// ```
pub fn description<T: Into<String>>(mut self, description: T) -> Self {
self.description = Some(description.into());
self
}
/// Set usage of the command
///
/// Example
///
/// ```
/// use seahorse::Command;
///
/// let command = Command::new("cmd")
/// .usage("cli cmd [arg]");
/// ```
pub fn usage<T: Into<String>>(mut self, usage: T) -> Self {
self.usage = Some(usage.into());
self
}
/// Set action of the command
///
/// Example
///
/// ```
/// use seahorse::{Command, Context, Action};
///
/// let action: Action = |c: &Context| println!("{:?}", c.args);
/// let command = Command::new("cmd")
/// .action(action);
/// ```
///
/// # Panics
///
/// You cannot set both action and action_with_result.
///
/// ```should_panic
/// use seahorse::{Action, ActionWithResult, Command, Context};
///
/// let action_with_result: ActionWithResult = |c: &Context| {println!("{:?}", c.args); Ok(())};
/// let action: Action = |c: &Context| println!("{:?}", c.args);
/// let command = Command::new("cmd")
/// .action_with_result(action_with_result)
/// .action(action);
/// ```
pub fn action(mut self, action: Action) -> Self {
if self.action_with_result.is_some() {
panic!(r#"only one of action and action_with_result can be set."#);
}
self.action = Some(action);
self
}
/// Set action of the command
///
/// Example
///
/// ```
/// use seahorse::{ActionWithResult, Command, Context};
///
/// let action_with_result: ActionWithResult = |c: &Context| {println!("{:?}", c.args); Ok(())};
/// let command = Command::new("cmd")
/// .action_with_result(action_with_result);
/// ```
///
/// # Panics
///
/// You cannot set both action and action_with_result.
///
/// ```should_panic
/// use seahorse::{Action, ActionWithResult, Command, Context};
///
/// let action_with_result: ActionWithResult = |c: &Context| {println!("{:?}", c.args); Ok(())};
/// let action: Action = |c: &Context| println!("{:?}", c.args);
/// let command = Command::new("cmd")
/// .action(action)
/// .action_with_result(action_with_result);
/// ```
pub fn action_with_result(mut self, action_with_result: ActionWithResult) -> Self {
if self.action.is_some() {
panic!(r#"only one of action and action_with_result can be set."#);
}
self.action_with_result = Some(action_with_result);
self
}
/// Set flag of the command
///
/// Example
///
/// ```
/// use seahorse::{Command, Flag, FlagType};
///
/// let command = Command::new("cmd")
/// .flag(Flag::new("bool", FlagType::Bool))
/// .flag(Flag::new("int", FlagType::Int));
/// ```
pub fn flag(mut self, flag: Flag) -> Self {
if let Some(ref mut flags) = self.flags {
(*flags).push(flag);
} else {
self.flags = Some(vec![flag]);
}
self
}
/// Set alias of the command
///
/// Example
///
/// ```
/// use seahorse::Command;
///
/// let command = Command::new("cmd")
/// .alias("c");
/// ```
pub fn alias<T: Into<String>>(mut self, name: T) -> Self {
if let Some(ref mut alias) = self.alias {
(*alias).push(name.into());
} else {
self.alias = Some(vec![name.into()]);
}
self
}
/// Set sub command of the command
///
/// Example
///
/// ```
/// use seahorse::{App, Command};
///
/// let sub_command = Command::new("world")
/// .usage("cli hello world")
/// .action(|_| println!("Hello world!"));
///
/// let command = Command::new("hello")
/// .usage("cli hello [arg]")
/// .action(|c| println!("{:?}", c.args))
/// .command(sub_command);
///
/// let app = App::new("cli")
/// .command(command);
/// ```
///
/// # Panics
///
/// You cannot set a command named as same as registered ones.
///
/// ```should_panic
/// use seahorse::{App, Command};
///
/// let sub_command1 = Command::new("world")
/// .usage("cli hello world")
/// .action(|_| println!("Hello world!"));
///
/// let sub_command2 = Command::new("world")
/// .usage("cli hello world")
/// .action(|_| println!("Hello world!"));
///
/// let command = Command::new("hello")
/// .usage("cli hello [arg]")
/// .action(|c| println!("{:?}", c.args))
/// .command(sub_command1)
/// .command(sub_command2);
///
/// let app = App::new("cli")
/// .command(command);
/// ```
pub fn command(mut self, command: Command) -> Self {
if let Some(ref mut commands) = self.commands {
if commands
.iter()
.any(|registered| registered.name == command.name)
{
panic!(r#"Command name "{}" is already registered."#, command.name);
}
(*commands).push(command);
} else {
self.commands = Some(vec![command]);
}
self
}
fn select_command(&self, cmd: &str) -> Option<&Command> {
match &self.commands {
Some(commands) => commands.iter().find(|command| match &command.alias {
Some(alias) => command.name == cmd || alias.iter().any(|a| a == cmd),
None => command.name == cmd,
}),
None => None,
}
}
fn normalized_args(raw_args: Vec<String>) -> Vec<String> {
raw_args.iter().fold(Vec::<String>::new(), |mut acc, cur| {
if cur.starts_with('-') && cur.contains('=') {
let mut splitted_flag: Vec<String> =
cur.splitn(2, '=').map(|s| s.to_owned()).collect();
acc.append(&mut splitted_flag);
} else {
acc.push(cur.to_owned());
}
acc
})
}
/// Run command
/// Call this function only from `App`
pub fn run_with_result(&self, args: Vec<String>) -> ActionResult {
let args = Self::normalized_args(args);
match args.split_first() {
Some((cmd, args_v)) => match self.select_command(cmd) {
Some(command) => {
return command.run_with_result(args_v.to_vec());
}
None => match self.action {
Some(action) => {
if args.contains(&"-h".to_string()) || args.contains(&"--help".to_string())
{
self.help();
return Ok(());
}
action(&Context::new(
args.to_vec(),
self.flags.clone(),
self.help_text(),
));
return Ok(());
}
None => match self.action_with_result {
Some(action_with_result) => {
if args.contains(&"-h".to_string())
|| args.contains(&"--help".to_string())
{
self.help();
return Ok(());
}
return action_with_result(&Context::new(
args.to_vec(),
self.flags.clone(),
self.help_text(),
));
}
None => {
self.help();
return Ok(());
}
},
},
},
None => match self.action {
Some(action) => {
if args.contains(&"-h".to_string()) || args.contains(&"--help".to_string()) {
self.help();
return Ok(());
}
action(&Context::new(
args.to_vec(),
self.flags.clone(),
self.help_text(),
));
return Ok(());
}
None => match self.action_with_result {
Some(action_with_result) => {
if args.contains(&"-h".to_string()) || args.contains(&"--help".to_string())
{
self.help();
return Ok(());
}
return action_with_result(&Context::new(
args.to_vec(),
self.flags.clone(),
self.help_text(),
));
}
None => {
self.help();
return Ok(());
}
},
},
}
}
fn flag_help_text(&self) -> String {
let mut text = String::new();
text += "Flags:\n";
let help_flag = "-h, --help";
if let Some(flags) = &self.flags {
let int_val = "<int>";
let float_val = "<float>";
let string_val = "<string>";
let flag_helps = &flags.iter().map(|f| {
let alias = match &f.alias {
Some(alias) => alias
.iter()
.map(|a| format!("-{}", a))
.collect::<Vec<String>>()
.join(", "),
None => String::new(),
};
let val = match f.flag_type {
FlagType::Int => int_val,
FlagType::Float => float_val,
FlagType::String => string_val,
_ => "",
};
let help = if alias.is_empty() {
format!("--{} {}", f.name, val)
} else {
format!("{}, --{} {}", alias, f.name, val)
};
(help, f.description.clone())
});
let flag_name_max_len = flag_helps
.clone()
.map(|h| h.0.len())
.chain(vec![help_flag.len()].into_iter())
.max()
.unwrap();
for flag_help in flag_helps.clone() {
text += &format!("\t{}", flag_help.0);
if let Some(usage) = &flag_help.1 {
let flag_name_len = flag_help.0.len();
text += &format!(
"{} : {}\n",
" ".repeat(flag_name_max_len - flag_name_len),
usage
);
} else {
text += "\n";
}
}
text += &format!(
"\t{}{} : Show help\n",
help_flag,
" ".repeat(flag_name_max_len - help_flag.len())
);
} else {
text += &format!("\t{} : Show help\n", help_flag);
}
text
}
fn command_help_text(&self) -> String {
let mut text = String::new();
if let Some(commands) = &self.commands {
text += "\nCommands:\n";
let name_max_len = &commands
.iter()
.map(|c| {
if let Some(alias) = &c.alias {
format!("{}, {}", alias.join(", "), c.name).len()
} else {
c.name.len()
}
})
.max()
.unwrap();
for c in commands {
let command_name = if let Some(alias) = &c.alias {
format!("{}, {}", alias.join(", "), c.name)
} else {
c.name.clone()
};
let description = match &c.description {
Some(description) => description,
None => "",
};
text += &format!(
"\t{} {}: {}\n",
command_name,
" ".repeat(name_max_len - command_name.len()),
description
);
}
}
text
}
}
impl Help for Command {
fn help_text(&self) -> String {
let mut text = String::new();
if let Some(description) = &self.description {
text += &format!("Description:\n\t{}\n\n", description);
}
if let Some(usage) = &self.usage {
text += &format!("Usage:\n\t{}\n\n", usage);
}
text += &self.flag_help_text();
text += &self.command_help_text();
text
}
}
#[cfg(test)]
mod tests {
use crate::{Action, Command, Context, Flag, FlagType};
#[test]
fn command_test() {
let a: Action = |c: &Context| println!("Hello, {:?}", c.args);
let c = Command::new("hello")
.description("usre command")
.usage("test hello user")
.alias("c")
.action(a)
.flag(Flag::new("t", FlagType::Bool));
assert_eq!(c.name, "hello".to_string());
assert_eq!(c.usage, Some("test hello user".to_string()));
}
#[test]
fn sub_command_test() {
let a: Action = |c: &Context| println!("Hello, {:?}", c.args);
let sub = Command::new("world")
.description("user command")
.usage("test hello world user")
.alias("w")
.action(a)
.flag(Flag::new("t", FlagType::Bool));
let c = Command::new("hello")
.description("user command")
.usage("test hello user")
.alias("h")
.action(a)
.flag(Flag::new("t", FlagType::Bool))
.command(sub);
assert_eq!(c.name, "hello".to_string());
assert_eq!(c.usage, Some("test hello user".to_string()));
}
}