aud 0.1.3

//! This library implements parts Saga system for execution and rollback
//! consectual steps.
//!
//! The basic concept of this installation is that each Saga is made of
//! a number of Adventures.
//! Each Adventure has a forward and backwards step.
//!
//! When a forward step returns a Failure, the state of that
//! is passed to the backwards step of this and all prior ones
//!
//! ```
//! // f1 -> f2 -> f3
//! //             | error
//! //             v
//! // b1 <- b2 <- b3
//! ```
//!
//! An simple example of a saga would be the following:
//!
//! ```
//!     use aud::Adventure;
//!     use aud::Failure;
//!     use aud::Saga;
//!     use std::error::Error;
//!     use std::fmt;
//!
//!
//!    #[derive(Debug)]
//!    pub struct StupidError {
//!        stupid: bool,
//!    }
//!
//!     impl Error for StupidError {
//!         fn description(&self) -> &str {
//!             "stupid error"
//!         }
//!     }
//!     impl fmt::Display for StupidError {
//!         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
//!             write!(f, "is stupid: {}", self.stupid)
//!         }
//!     }
//!     fn inc2(i: i32) -> Result<i32, Failure<i32>> {
//!             Ok(i + 1)
//!     }
//!     fn dec(i: i32) -> i32 {
//!         i - 1
//!     }
//!     fn main() {
//!         let saga = Saga::new(vec![
//!             Adventure::new(inc2,dec),
//!             Adventure::new(inc2,dec),
//!         ]);
//!         match saga.tell(0) {
//!             Ok(res) => assert!(res == 2),
//!             Err(_) => unimplemented!(),
//!         }
//!     }
//! ```

#![deny(trivial_numeric_casts,
        missing_docs,
        unstable_features,
        unused_import_braces,
)]
use std::error::Error;

/// A sage of many adventures that can be told.
pub struct Saga<T> {
    adventures: Vec<Adventure<T>>,
}

impl<T> Saga<T> {
    /// Creates a new saga from a vector of adventures
    pub fn new(adventures: Vec<Adventure<T>>) -> Self {
        Saga { adventures: adventures }
    }
    /// Tells a saga, reverts on failure and returns either the result or error
    pub fn tell(self: &Self, acc: T) -> Result<T, Failure<T>> {
        tell_(&self.adventures, 0, acc)
    }
}

/// An adventure that can can forward succeed or fail and be reverted.
/// Make sure that a failure includes enough info for THIS step itsel
/// to be reverted
pub struct Adventure<T> {
    forward: fn(T) -> Result<T, Failure<T>>,
    backward: fn(T) -> T,
}

impl<T> Adventure<T> {
    /// Creates a new adventure with a forward and backward step
    pub fn new(forward: fn(T) -> Result<T, Failure<T>>, backward: fn(T) -> T) -> Self {
        Adventure { forward, backward }
    }
    fn forward(self: &Adventure<T>, acc: T) -> Result<T, Failure<T>> {
        let f = self.forward;
        f(acc)
    }
    fn backward(self: &Adventure<T>, acc: T) -> T {
        let f = self.backward;
        f(acc)
    }
}

/// A simple failure that can return an error along with the new state.
pub struct Failure<T> {
    error: Box<Error>,
    state: T,
}

impl<T> Failure<T> {
    /// Creates a new failure from a state and an error
    pub fn new(state: T, error: Box<Error>) -> Self {
        Failure { state, error }
    }
    /// Truns the Failure into an Err
    pub fn to_error(self) -> Box<Error> {
        self.error
    }
}

fn tell_<T>(saga: &Vec<Adventure<T>>, i: usize, acc: T) -> Result<T, Failure<T>> {
    if i >= saga.len() {
        Ok(acc)
    } else {
        match saga[i].forward(acc) {
            Ok(acc1) => tell_(saga, i + 1, acc1),
            Err(Failure { state: acc1, error }) => Err(revert(saga, error, i, acc1)),
        }
    }
}

fn revert<T>(saga: &Vec<Adventure<T>>, error: Box<Error>, i: usize, acc: T) -> Failure<T> {
    let acc1 = saga[i].backward(acc);
    if i == 0 {
        Failure { error, state: acc1 }
    } else {
        revert(saga, error, i - 1, acc1)
    }
}

#[cfg(test)]
mod tests {
    use Adventure;
    use Failure;
    use Saga;
    use std::error::Error;
    use std::fmt;

    #[derive(Debug)]
    pub struct StupidError {
        stupid: bool,
    }

    impl Error for StupidError {
        fn description(&self) -> &str {
            "stupid error"
        }
    }
    impl fmt::Display for StupidError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "is stupid: {}", self.stupid)
        }
    }
    fn inc2(i: i32) -> Result<i32, Failure<i32>> {
        if i >= 2 {
            Err(Failure::new(i + 1, Box::new(StupidError { stupid: true })))
        } else {
            Ok(i + 1)
        }
    }
    fn dec(i: i32) -> i32 {
        i - 1
    }
    #[test]
    fn good_sage() {
        let saga = Saga::new(vec![Adventure::new(inc2, dec), Adventure::new(inc2, dec)]);
        match saga.tell(0) {
            Ok(res) => assert!(res == 2),
            Err(_) => unimplemented!(),
        }
    }
    #[test]
    fn bad_sage() {
        let saga = Saga::new(vec![
            Adventure::new(inc2, dec),
            Adventure::new(inc2, dec),
            Adventure::new(inc2, dec),
        ]);
        match saga.tell(0) {
            Ok(_) => unimplemented!(),
            Err(Failure { state: res, .. }) => assert_eq!(res, 0),
        }

    }

}