ebi 0.3.12

A stochastic process mining utility and library
Documentation
use crate::{
    ebi_framework::{
        ebi_file_handler::{EBI_FILE_HANDLERS, EbiFileHandler},
        ebi_input::EbiInputType,
    },
    text::Joiner,
};
use clap::{Arg, ArgAction, ArgMatches, Command, builder::ValueParser, value_parser};
use ebi_objects::{
    anyhow::{Result, anyhow},
    ebi_arithmetic::{Fraction, parsing::FractionNotParsedYet},
    traits::importable::{ImporterParameter, ImporterParameterValue, ImporterParameterValues},
};
use std::collections::BTreeSet;

pub fn merge_importer_parameters(
    input_types: &[&EbiInputType],
) -> BTreeSet<&'static ImporterParameter> {
    let mut result = BTreeSet::new();
    for input_type in input_types {
        match input_type {
            EbiInputType::Trait(ebi_trait) => {
                //look for file handlers that can import this trait
                for file_handler in EBI_FILE_HANDLERS {
                    for importer in file_handler.trait_importers {
                        if &importer.get_trait() == ebi_trait {
                            //found an importer for this trait; copy its parameters
                            for parameter in importer.parameters() {
                                result.insert(parameter);
                            }
                        }
                    }
                }
            }
            EbiInputType::Object(ebi_object_type) => {
                //look for file handlers that cn import this object
                for file_handler in EBI_FILE_HANDLERS {
                    for importer in file_handler.object_importers {
                        if &importer.get_type() == ebi_object_type {
                            //found an importer for this trait; copy its parameters
                            for parameter in importer.parameters() {
                                result.insert(parameter);
                            }
                        }
                    }
                    for importer in file_handler.object_importers_fallible {
                        if &importer.get_type() == ebi_object_type {
                            //found an importer for this trait; copy its parameters
                            for parameter in importer.parameters() {
                                result.insert(parameter);
                            }
                        }
                    }
                }
            }
            EbiInputType::AnyObject => {
                //look for any object importer
                for file_handler in EBI_FILE_HANDLERS {
                    for importer in file_handler.object_importers {
                        //found an importer; copy its parameters
                        for parameter in importer.parameters() {
                            result.insert(parameter);
                        }
                    }
                }
            }
            _ => {}
        }
    }
    result
}

pub fn file_handler_2_importer_parameters(
    file_handler: &EbiFileHandler,
) -> BTreeSet<&'static ImporterParameter> {
    let mut result = BTreeSet::new();
    for importer in file_handler.object_importers {
        //found an importer for this trait; copy its parameters
        for parameter in importer.parameters() {
            result.insert(parameter);
        }
    }
    result
}

pub fn build_cli(
    mut command: Command,
    parameters: BTreeSet<&'static ImporterParameter>,
    input_index: usize,
) -> Command {
    for parameter in parameters {
        let gui_id = format!("input{}_{}", input_index, parameter.name());
        let mut arg = Arg::new(&gui_id)
            .long(gui_id)
            .help(parameter.explanation())
            .required(false)
            .long_help(format!(
                "{}. {}",
                parameter.explanation(),
                explanation_with_values(parameter)
            ));
        arg = match parameter {
            ImporterParameter::Flag { .. } => arg.action(ArgAction::SetTrue),
            ImporterParameter::String {
                explanation,
                allowed_values,
                default_value,
                ..
            } => {
                let parser: ValueParser = value_parser!(String).into();

                if let Some(allowed) = allowed_values {
                    let allowed = allowed
                        .iter()
                        .map(|s| s.to_string())
                        .collect::<Vec<_>>()
                        .join_with(", ", " and ");
                    arg = arg.long_help(format!(
                        "{}. Allowed values: {}. Default value: {}",
                        explanation, allowed, default_value
                    ));
                }

                arg.action(ArgAction::Set).value_parser(parser)
            }
            ImporterParameter::Usize { .. } => {
                let parser: ValueParser = value_parser!(usize).into();
                arg.action(ArgAction::Set).value_parser(parser)
            }
            ImporterParameter::Fraction { .. } => {
                let parser: ValueParser = value_parser!(FractionNotParsedYet).into();
                arg.action(ArgAction::Set).value_parser(parser)
            }
        };
        command = command.arg(arg)
    }
    command
}

pub fn explanation_with_values(parameter: &ImporterParameter) -> String {
    match parameter {
        ImporterParameter::Flag { .. } => "".to_string(),
        ImporterParameter::String {
            allowed_values,
            default_value,
            ..
        } => {
            if let Some(allowed) = allowed_values {
                let allowed = allowed
                    .iter()
                    .map(|s| s.to_string())
                    .collect::<Vec<_>>()
                    .join_with("', `", "' or `");
                format!(
                    "May be any of the values `{}'. The default value is `{}'.",
                    allowed, default_value
                )
            } else {
                format!("The default value is `{}'.", default_value)
            }
        }
        ImporterParameter::Usize {
            minimum_value,
            maximum_value,
            default_value,
            ..
        } => format!(
            "Must be an {}; the default is {}.",
            match (minimum_value, maximum_value) {
                (None, None) => "integer".to_string(),
                (None, Some(max)) => format!("integer below or equal to {}", max),
                (Some(min), None) => format!("integer above or equal to {}", min),
                (Some(min), Some(max)) => format!("integer between {} and {}", min, max),
            },
            default_value
        ),
        ImporterParameter::Fraction {
            minimum_value,
            maximum_value,
            default_value,
            ..
        } => format!(
            "Must be a {}; the default is {}.",
            match (minimum_value, maximum_value) {
                (None, None) => "fraction".to_string(),
                (None, Some(max)) => format!("fraction below or equal to {}", max),
                (Some(min), None) => format!("fraction above or equal to {}", min),
                (Some(min), Some(max)) => format!("fraction between {} and {}", min, max),
            },
            default_value
        ),
    }
}

pub fn has_accepted_values(parameter: &ImporterParameter) -> bool {
    match parameter {
        ImporterParameter::Flag { .. } => false,
        ImporterParameter::String { allowed_values, .. } => allowed_values.is_some(),
        ImporterParameter::Usize {
            minimum_value,
            maximum_value,
            ..
        } => minimum_value.is_some() || maximum_value.is_some(),
        ImporterParameter::Fraction {
            minimum_value,
            maximum_value,
            ..
        } => minimum_value.is_some() || maximum_value.is_some(),
    }
}

/// Get parameters from CLI, appended with defaults.
pub fn extract_parameter_values(
    cli_matches: Option<&ArgMatches>,
    parameters: &'static [ImporterParameter],
    input_index: usize,
) -> Result<ImporterParameterValues> {
    let mut result = ImporterParameterValues::new();

    for parameter in parameters {
        result.insert(
            *parameter,
            match parameter {
                ImporterParameter::Flag { name, .. } => {
                    if let Some(cli_matches) = cli_matches {
                        (
                            ImporterParameterValue::Boolean(
                                *cli_matches
                                    .get_one::<bool>(&name_to_id(name, input_index))
                                    .unwrap_or(&false),
                            ),
                            true,
                        )
                    } else {
                        (ImporterParameterValue::Boolean(false), true)
                    }
                }
                ImporterParameter::String {
                    name,
                    allowed_values,
                    default_value,
                    ..
                } => {
                    if let Some(cli_matches) = cli_matches {
                        if let Some(value) =
                            cli_matches.get_one::<String>(&name_to_id(name, input_index))
                        {
                            if let Some(allowed_values) = allowed_values {
                                if allowed_values.contains(&value.as_str()) {
                                    (ImporterParameterValue::String(value.to_string()), true)
                                } else {
                                    return Err(anyhow!(
                                        "Value should be one of {:?}.",
                                        allowed_values
                                    ));
                                }
                            } else {
                                (ImporterParameterValue::String(value.to_string()), true)
                            }
                        } else {
                            (
                                ImporterParameterValue::String(default_value.to_string()),
                                true,
                            )
                        }
                    } else {
                        (
                            ImporterParameterValue::String(default_value.to_string()),
                            true,
                        )
                    }
                }
                ImporterParameter::Usize {
                    name,
                    minimum_value,
                    maximum_value,
                    default_value,
                    ..
                } => {
                    if let Some(cli_matches) = cli_matches {
                        if let Some(value) =
                            cli_matches.get_one::<usize>(&name_to_id(name, input_index))
                        {
                            match (minimum_value, maximum_value) {
                                (Some(min), Some(max)) => {
                                    if value < min || value > max {
                                        return Err(anyhow!(
                                            "Value must be between {} and {}.",
                                            min,
                                            max
                                        ));
                                    } else {
                                        (ImporterParameterValue::Usize(*value), true)
                                    }
                                }
                                (Some(min), None) => {
                                    if value < min {
                                        return Err(anyhow!("Value must be below {}.", min));
                                    } else {
                                        (ImporterParameterValue::Usize(*value), true)
                                    }
                                }
                                (None, Some(max)) => {
                                    if value > max {
                                        return Err(anyhow!("Value must be above {}.", max));
                                    } else {
                                        (ImporterParameterValue::Usize(*value), true)
                                    }
                                }
                                (None, None) => (ImporterParameterValue::Usize(*value), true),
                            }
                        } else {
                            (ImporterParameterValue::Usize(*default_value), true)
                        }
                    } else {
                        (ImporterParameterValue::Usize(*default_value), true)
                    }
                }
                ImporterParameter::Fraction {
                    name,
                    minimum_value,
                    maximum_value,
                    default_value,
                    ..
                } => {
                    if let Some(cli_matches) = cli_matches {
                        if let Some(value) = cli_matches
                            .get_one::<FractionNotParsedYet>(&name_to_id(name, input_index))
                        {
                            let value: Fraction = value.try_into()?;
                            match (minimum_value, maximum_value) {
                                (Some(min), Some(max)) => {
                                    if min > &value || max < &value {
                                        return Err(anyhow!(
                                            "Value must be between {} and {}.",
                                            min,
                                            max
                                        ));
                                    } else {
                                        (ImporterParameterValue::Fraction(value), true)
                                    }
                                }
                                (Some(min), None) => {
                                    if min > &value {
                                        return Err(anyhow!("Value must be below {}.", min));
                                    } else {
                                        (ImporterParameterValue::Fraction(value), true)
                                    }
                                }
                                (None, Some(max)) => {
                                    if max > &value {
                                        return Err(anyhow!("Value must be above {}.", max));
                                    } else {
                                        (ImporterParameterValue::Fraction(value), true)
                                    }
                                }
                                (None, None) => (ImporterParameterValue::Fraction(value), true),
                            }
                        } else {
                            (
                                ImporterParameterValue::Fraction(default_value.to_fraction()),
                                true,
                            )
                        }
                    } else {
                        (
                            ImporterParameterValue::Fraction(default_value.to_fraction()),
                            true,
                        )
                    }
                }
            },
        );
    }

    Ok(result)
}

pub fn name_to_id(name: &str, input_index: usize) -> String {
    format!("input{}_{}", input_index, name)
}