phonet 1.0.2

/// Display function for `Outcome` struct
mod display;
/// Run function for `Outcome` struct
mod run;

pub(crate) use self::run::{validate_test, Validity};

use crate::draft::{Message, Note};

/// Outcome of tests ran from *Phonet* `Draft`
///
/// Use `Outcome::display` method to display output to stdout
///
/// # Examples
///
/// ```
/// # use phonet::Draft;
/// # let file = "
/// #   ~<>
/// #   $_ = [ptkaeiou]
/// #   * Some note
/// #     + ^ <_>+ $
/// #       ?+ kato
/// #       ?! x10
/// # ";
/// let draft = Draft::from(file).unwrap();
///
/// let outcome = draft.run();
///
/// assert_eq!(outcome.messages.len(), 3);
/// assert_eq!(outcome.fail_count, 0);
///
/// outcome.display(Default::default(), true); // Prints results to stdout
/// ```
#[derive(Debug)]
pub struct Outcome {
    /// Messages to display
    pub messages: Vec<Message<TestOutcome>>,
    /// Amount of failed tests ran
    pub fail_count: usize,
}

/// Outcome of `TestDraft` that was ran
#[derive(Debug, PartialEq)]
pub struct TestOutcome {
    /// String that was tested
    pub word: String,
    /// Whether test should have been valid or not to pass
    pub intent: bool,
    /// Whether the test has passed or not
    pub status: PassStatus,
}

/// Status of test that was ran
#[derive(Debug, PartialEq)]
pub enum PassStatus {
    /// Test passed
    ///
    /// Intent and validity matched
    Pass,
    /// Test failed
    ///
    /// Intent and validity did not match
    Fail(FailKind),
}

/// The manner in which a test failed
#[derive(Debug, PartialEq)]
pub enum FailKind {
    /// The test was supposed to not match the rules, however it did
    ShouldBeInvalid,
    /// The test was invalid, but should have matched
    ///
    /// No reason was given for this fail
    NoReasonGiven,
    /// The test was invalid, but should have matched
    ///
    /// A custom reason was given to the rule of which this test failed against
    CustomReason(Note),
}

/// The kinds of messages to display to the output, when `Outcome::display` is called
#[derive(Debug, Clone, Copy)]
pub enum DisplayLevel {
    /// Show everything: passed or failed tests, and notes
    ShowAll,
    /// Show failed tests and notes, but not passes
    IgnorePasses,
    /// Show only failed tests, not passed tests or notes
    OnlyFails,
    /// Show nothing: not passed or failed tests, or notes
    HideAll,
}

impl PassStatus {
    /// Returns `true` if self is `Pass`
    pub fn is_pass(&self) -> bool {
        matches!(self, Self::Pass)
    }

    /// Returns `true` if self is `Fail`
    pub fn is_fail(&self) -> bool {
        matches!(self, Self::Fail(_))
    }
}

impl Default for DisplayLevel {
    fn default() -> Self {
        Self::ShowAll
    }
}