ebi 0.3.14

A stochastic process mining utility and library
Documentation
use ebi_objects::{
    EbiObject, EbiObjectType, anyhow::anyhow, ebi_objects::scalable_vector_graphics::ToSVG,
};

use crate::{
    ebi_framework::{
        ebi_command::EbiCommand,
        ebi_input::{EbiInput, EbiInputType},
        ebi_output::{EbiOutput, EbiOutputType},
        ebi_trait::EbiTrait,
    },
    ebi_traits::ebi_trait_graphable::EbiTraitGraphable,
};

pub const EBI_VISUALISE: EbiCommand = EbiCommand::Group {
    name_short: "vis",
    name_long: Some("visualise"),
    explanation_short: "Visualse an object.",
    explanation_long: None,
    children: &[&EBI_VISUALISE_GRAPH, &EBI_VISUALISE_TEXT],
};

pub const EBI_VISUALISE_TEXT: EbiCommand = EbiCommand::Command {
    name_short: "txt",
    name_long: Some("text"),
    explanation_short: "Visualise a file as text.",
    explanation_long: None,
    latex_link: None,
    cli_command: None,
    exact_arithmetic: false,
    input_types: &[&[&EbiInputType::AnyObject]],
    input_names: &["FILE"],
    input_helps: &["Any file that can be visualised textually."],
    execute: |mut inputs, _| {
        let object = inputs.remove(0);
        let result = match object {
            EbiInput::Object(EbiObject::BusinessProcessModelAndNotation(bpmn), _) => {
                bpmn.to_string()
            }
            EbiInput::Object(EbiObject::StochasticBusinessProcessModelAndNotation(bpmn), _) => {
                bpmn.to_string()
            }
            EbiInput::Object(EbiObject::StochasticLabelledPetriNet(slpn), _) => slpn.to_string(),
            EbiInput::Object(EbiObject::LabelledPetriNet(lpn), _) => lpn.to_string(),
            EbiInput::Object(EbiObject::FiniteStochasticLanguage(lang), _) => lang.to_string(),
            EbiInput::Object(EbiObject::StochasticDeterministicFiniteAutomaton(sdfa), _) => {
                sdfa.to_string()
            }
            EbiInput::Object(EbiObject::StochasticNondeterministicFiniteAutomaton(snfa), _) => {
                snfa.to_string()
            }
            EbiInput::Object(EbiObject::EventLog(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogCsv(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogEventAttributes(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogOcel(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogPython(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogTraceAttributes(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::EventLogXes(log), _) => log.to_string(),
            EbiInput::Object(EbiObject::FiniteLanguage(language), _) => language.to_string(),
            EbiInput::Object(EbiObject::FiniteStochasticPartiallyOrderedLanguage(language), _) => {
                language.to_string()
            }
            EbiInput::Object(EbiObject::DirectlyFollowsModel(d), _) => d.to_string(),
            EbiInput::Object(EbiObject::StochasticDirectlyFollowsModel(d), _) => d.to_string(),
            EbiInput::Object(EbiObject::LanguageOfAlignments(a), _) => a.to_string(),
            EbiInput::Object(EbiObject::StochasticLanguageOfAlignments(a), _) => a.to_string(),
            EbiInput::Object(EbiObject::DeterministicFiniteAutomaton(s), _) => s.to_string(),
            EbiInput::Object(EbiObject::ProcessTree(pt), _) => pt.to_string(),
            EbiInput::Object(EbiObject::StochasticProcessTree(pt), _) => pt.to_string(),
            EbiInput::Object(EbiObject::PartiallyOrderedWorkflowLanguage(pt), _) => pt.to_string(),
            EbiInput::Object(EbiObject::Executions(s), _) => s.to_string(),
            EbiInput::Object(EbiObject::DirectlyFollowsGraph(s), _) => s.to_string(),
            EbiInput::Object(EbiObject::ScalableVectorGraphics(s), _) => s.to_string(),
            EbiInput::Object(EbiObject::PortableDocumentFormat(s), _) => s.to_string(),
            EbiInput::Object(EbiObject::PortableNetworkGraphics(s), _) => s.to_string(),
            EbiInput::FileHandler(_) => {
                return Err(anyhow!(
                    "Unsupported object {:?} provided.",
                    object.get_type()
                ));
            }
            EbiInput::Trait(_, _) => {
                return Err(anyhow!(
                    "Unsupported object {:?} provided.",
                    object.get_type()
                ));
            }
            EbiInput::String(_, _) => {
                return Err(anyhow!(
                    "Unsupported object {:?} provided.",
                    object.get_type()
                ));
            }
            EbiInput::Usize(_, _) => {
                return Err(anyhow!(
                    "Unsupported object {:?} provided.",
                    object.get_type()
                ));
            }
            EbiInput::Fraction(_, _) => {
                return Err(anyhow!(
                    "Unsupported object {:?} provided.",
                    object.get_type()
                ));
            }
        };
        Ok(EbiOutput::String(result))
    },
    output_type: &EbiOutputType::String,
};

pub const EBI_VISUALISE_GRAPH: EbiCommand = EbiCommand::Command {
    name_short: "graph",
    name_long: None,
    explanation_short: "Visualise a file as a graph.",
    explanation_long: None,
    latex_link: None,
    cli_command: None,
    exact_arithmetic: true,
    input_types: &[&[&EbiInputType::Trait(EbiTrait::Graphable)]],
    input_names: &["FILE"],
    input_helps: &["Any file that can be visualised as a graph."],
    execute: |mut inputs, _| {
        let result: Box<dyn EbiTraitGraphable + 'static> =
            inputs.remove(0).to_type::<dyn EbiTraitGraphable>()?;

        return Ok(EbiOutput::Object(EbiObject::ScalableVectorGraphics(
            result.to_svg()?,
        )));
    },
    output_type: &EbiOutputType::ObjectType(EbiObjectType::ScalableVectorGraphics),
};

#[cfg(test)]
mod tests {

    use crate::{
        ebi_commands::ebi_command_visualise::EBI_VISUALISE_TEXT,
        ebi_file_handlers::stochastic_labelled_petri_net::EBI_STOCHASTIC_LABELLED_PETRI_NET,
        ebi_framework::{
            ebi_command::EbiCommand,
            ebi_input::{
                EbiInput, TEST_INPUT_TYPE_FRACTION, TEST_INPUT_TYPE_STRING, TEST_INPUT_TYPE_USIZE,
            },
            ebi_trait_object::EbiTraitObject,
        },
    };
    use ebi_objects::{
        FiniteLanguage,
        ebi_arithmetic::{Fraction, One},
    };

    #[test]
    fn visualise_as_text() {
        for (object, _, _, _) in crate::tests::tests::get_all_test_files() {
            if let EbiInput::Object(_, _) = object {
                if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
                    let _ = (execute)(vec![object], None);
                }
            }
        }
    }

    #[test]
    fn unreachable_filehandler() {
        let object = EbiInput::FileHandler(EBI_STOCHASTIC_LABELLED_PETRI_NET);
        if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
            assert!((execute)(vec![object], None).is_err());
        }
    }

    #[test]
    fn unreachable_string() {
        let object = EbiInput::String("abc".to_string(), &TEST_INPUT_TYPE_STRING);
        if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
            assert!((execute)(vec![object], None).is_err());
        }
    }

    #[test]
    fn unreachable_usize() {
        let object = EbiInput::Usize(10, &TEST_INPUT_TYPE_USIZE);
        if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
            assert!((execute)(vec![object], None).is_err());
        }
    }

    #[test]
    fn unreachable_fraction() {
        let object = EbiInput::Fraction(Fraction::one(), &TEST_INPUT_TYPE_FRACTION);
        if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
            assert!((execute)(vec![object], None).is_err());
        }
    }

    #[test]
    fn unreachable_trait() {
        let net = "finite language\n0";
        let lang = net.parse::<FiniteLanguage>().unwrap();
        let object = EbiInput::Trait(
            EbiTraitObject::FiniteLanguage(Box::new(lang)),
            &EBI_STOCHASTIC_LABELLED_PETRI_NET,
        );
        if let EbiCommand::Command { execute, .. } = EBI_VISUALISE_TEXT {
            assert!((execute)(vec![object], None).is_err());
        }
    }
}