himalaya/src/domain/msg/flag_arg.rs

//! Message flag CLI module.
//!
//! This module provides subcommands, arguments and a command matcher related to the message flag
//! domain.

use anyhow::Result;
use clap::{self, App, AppSettings, Arg, ArgMatches, SubCommand};
use log::{debug, trace};

use crate::domain::msg::msg_arg;

type SeqRange<'a> = &'a str;
type Flags<'a> = Vec<&'a str>;

/// Represents the flag commands.
pub enum Command<'a> {
    /// Represents the add flags command.
    Add(SeqRange<'a>, Flags<'a>),
    /// Represents the set flags command.
    Set(SeqRange<'a>, Flags<'a>),
    /// Represents the remove flags command.
    Remove(SeqRange<'a>, Flags<'a>),
}

/// Defines the flag command matcher.
pub fn matches<'a>(m: &'a ArgMatches) -> Result<Option<Command<'a>>> {
    if let Some(m) = m.subcommand_matches("add") {
        debug!("add subcommand matched");
        let seq_range = m.value_of("seq-range").unwrap();
        trace!(r#"seq range: "{}""#, seq_range);
        let flags: Vec<&str> = m.values_of("flags").unwrap_or_default().collect();
        trace!(r#"flags: "{:?}""#, flags);
        return Ok(Some(Command::Add(seq_range, flags)));
    }

    if let Some(m) = m.subcommand_matches("set") {
        debug!("set subcommand matched");
        let seq_range = m.value_of("seq-range").unwrap();
        trace!(r#"seq range: "{}""#, seq_range);
        let flags: Vec<&str> = m.values_of("flags").unwrap_or_default().collect();
        trace!(r#"flags: "{:?}""#, flags);
        return Ok(Some(Command::Set(seq_range, flags)));
    }

    if let Some(m) = m.subcommand_matches("remove") {
        trace!("remove subcommand matched");
        let seq_range = m.value_of("seq-range").unwrap();
        trace!(r#"seq range: "{}""#, seq_range);
        let flags: Vec<&str> = m.values_of("flags").unwrap_or_default().collect();
        trace!(r#"flags: "{:?}""#, flags);
        return Ok(Some(Command::Remove(seq_range, flags)));
    }

    Ok(None)
}

/// Defines the flags argument.
fn flags_arg<'a>() -> Arg<'a, 'a> {
    Arg::with_name("flags")
        .help("IMAP flags")
        .long_help("IMAP flags. Flags are case-insensitive, and they do not need to be prefixed with `\\`.")
        .value_name("FLAGS…")
        .multiple(true)
        .required(true)
}

/// Contains flag subcommands.
pub fn subcmds<'a>() -> Vec<App<'a, 'a>> {
    vec![SubCommand::with_name("flag")
        .aliases(&["flags", "flg"])
        .about("Handles flags")
        .setting(AppSettings::SubcommandRequiredElseHelp)
        .subcommand(
            SubCommand::with_name("add")
                .aliases(&["a"])
                .about("Adds flags to a message")
                .arg(msg_arg::seq_range_arg())
                .arg(flags_arg()),
        )
        .subcommand(
            SubCommand::with_name("set")
                .aliases(&["s", "change", "c"])
                .about("Replaces all message flags")
                .arg(msg_arg::seq_range_arg())
                .arg(flags_arg()),
        )
        .subcommand(
            SubCommand::with_name("remove")
                .aliases(&["rem", "rm", "r", "delete", "del", "d"])
                .about("Removes flags from a message")
                .arg(msg_arg::seq_range_arg())
                .arg(flags_arg()),
        )]
}