retrosheet 0.2.4

use crate::event::Event;
use crate::game::{Game, GameError, GameState};
use crate::parsers::event;

pub use self::Error as ParserError;

#[derive(Clone, Debug, PartialEq)]
/// An error that occurs while parsing an event file.
pub enum Error {
    /// The parser received an unexpected `game_id` event.
    UnexpectedGameId {
        /// The id of the game already registered.
        current_game_id: String,
    },
    /// The parser received an game event without a game having been started.
    NoGame(Event),
    /// There were bytes remaining after attempting to parse the event file.
    StringRemaining(String),
    /// An error occurred while processing events for a game.
    GameProcessingError(GameError),
}

impl ::std::fmt::Display for Error {
    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
        match *self {
            Error::UnexpectedGameId {
                ref current_game_id,
            } => write!(
                f,
                "game_id event was received before finishing game '{}'",
                current_game_id
            ),
            Error::NoGame(ref evt) => write!(
                f,
                "event {:?} was received before a game was registered",
                evt
            ),
            Error::StringRemaining(ref s) => {
                write!(f, "string remaining after parsing completed: {:?}", s)
            }
            Error::GameProcessingError(ref e) => write!(f, "{}", e),
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
enum State {
    Empty,
    Game(Game),
}

#[derive(Clone, Debug, PartialEq)]
/// An event file parser for Retrosheet event files.
pub struct Parser {
    state: State,
}

impl Default for Parser {
    fn default() -> Self {
        Self::new()
    }
}

// TODO: Reconsider this API. Make this static? Or make the parser truly pauseable?
impl Parser {
    /// Creates a new parser instance.
    pub fn new() -> Parser {
        Parser {
            state: State::Empty,
        }
    }

    /// Resets the parser to the initial state.
    pub fn reset(&mut self) {
        self.state = State::Empty;
    }

    /// Parses an event file.
    ///
    /// This returns a list of the games in the event file.
    ///
    /// # Arguments
    /// * bytes - A stream of byte-data containing the entirety of the event file.
    ///
    /// # Errors
    /// The parser expects the byte-data coming in to be a *complete* event file, so any bytes
    /// remaining are counted as an error. Any other errors are from invalid events.
    pub fn parse(&mut self, mut bytes: &str) -> Result<Vec<Game>, Error> {
        let mut result = Vec::new();
        while let Ok((rest, evt)) = event(bytes) {
            let mut new_game: Option<Game> = None;
            match self.state {
                State::Empty => {
                    // The only valid event when the state is empty is a game ID (which marks a new
                    // game).
                    if let Event::GameId { id } = evt {
                        new_game = Some(Game::new(id));
                    } else {
                        return Err(Error::NoGame(evt.clone()));
                    }
                }
                State::Game(ref mut game) => {
                    match evt {
                        Event::GameId { id } => {
                            // Game IDs can't appear until the previous game is done.
                            if let GameState::Data = game.state {
                                // The data stage is the last stage of game processing, so if an id
                                // event occurs during that stage, that means the previous game is
                                // done being parsed.
                                new_game = Some(Game::new(id));
                            } else {
                                return Err(Error::UnexpectedGameId {
                                    current_game_id: game.id.clone(),
                                });
                            }
                        }
                        Event::Version { .. } => {
                            // We actually don't care about the version as long as it came in a
                            // valid location.
                        }
                        _ => {
                            game.process_event(evt)
                                .map_err(Error::GameProcessingError)?;
                        }
                    }
                }
            }
            if let Some(game) = new_game {
                // We do this because we can't borrow the state mutably twice up there during the
                // match, and it would be too awkward to work around that.
                if self.state != State::Empty {
                    // Pull out the current game in the state and finish it up, then add to the list
                    if let State::Game(mut game) =
                        ::std::mem::replace(&mut self.state, State::Empty)
                    {
                        game.finish().map_err(Error::GameProcessingError)?;
                        result.push(game);
                    }
                }
                self.state = State::Game(game);
            }
            bytes = rest;
        }
        if !bytes.is_empty() {
            Err(Error::StringRemaining(bytes.to_string()))
        } else {
            if self.state != State::Empty {
                // We reached the end of input after a game, so make sure the game can be validly
                // finished, and then add it.
                if let State::Game(mut game) = ::std::mem::replace(&mut self.state, State::Empty) {
                    game.finish().map_err(Error::GameProcessingError)?;
                    result.push(game);
                }
            }
            Ok(result)
        }
    }
}

#[cfg(test)]
mod tests {
    use std::collections::{HashMap, HashSet};
    use std::iter::FromIterator;

    use event::{
        Advance, Base, DataEventType, Event, Info, Pitch, PlayDescription, Player, PlayEvent, Team,
    };
    use game::{Game, GameError, GameState, Substitution};

    use super::*;

    const SHORT_GAME: &'static str = "id,CHN201506130
version,2
info,number,0
start,foo,\"Bar\",0,1,6
play,4,1,meh,12,CCX,S8.B-2
play,4,1,buz,00,,NP
sub,buz,\"Bax\",1,3,4
data,er,foo,2";

    fn short_game() -> Game {
        let mut game = Game::new("CHN201506130");
        game.info = {
            let mut map = HashMap::new();
            map.insert(Info::Number, "0".into());
            map
        };
        game.starters = HashSet::from_iter(
            vec![Player {
                id: "foo".into(),
                name: "Bar".into(),
                team: Team::Visiting,
                batting_pos: 1,
                fielding_pos: 6,
            }]
            .into_iter(),
        );
        game.plays = vec![
            (
                Event::Play {
                    inning: 4,
                    team: Team::Home,
                    player: "meh".into(),
                    count: Some((1, 2)),
                    pitches: vec![
                        Pitch::CalledStrike,
                        Pitch::CalledStrike,
                        Pitch::BallInPlayBatter,
                    ],
                    event: PlayEvent {
                        description: PlayDescription::Single(vec![8]),
                        modifiers: vec![],
                        advances: vec![Advance {
                            from: Base::Home,
                            to: Base::Second,
                            success: true,
                            parameters: vec![],
                        }],
                    },
                },
                vec![],
            ), // The NP should be gone because of the sub!
        ];
        game.data = vec![Event::Data {
            data_type: DataEventType::EarnedRuns,
            player: "foo".into(),
            value: "2".into(),
        }];
        game.substitutions = vec![Substitution {
            inning: 4,
            batting_team: Team::Home,
            player: Player {
                id: "buz".into(),
                name: "Bax".into(),
                team: Team::Home,
                batting_pos: 3,
                fielding_pos: 4,
            },
        }];

        game
    }

    #[test]
    fn test_game_parse() {
        let game_expected = short_game();

        let mut parser = Parser::new();
        assert_eq!(State::Empty, parser.state);

        let result = parser.parse(SHORT_GAME).unwrap();
        let ref game_result: Game = result[0];
        assert_eq!(game_expected, *game_result);

        assert_eq!(State::Empty, parser.state);
    }

    #[test]
    fn test_multiple_games_parse() {
        let game_expected = short_game();

        let buf = {
            let mut buf: String = SHORT_GAME.to_string();
            buf += "\n";
            buf += SHORT_GAME;
            buf
        };

        let mut parser = Parser::new();

        let result = parser.parse(&buf).unwrap();
        let ref game_result1: Game = result[0];
        let ref game_result2: Game = result[1];

        assert_eq!(game_expected, *game_result1);
        assert_eq!(game_expected, *game_result2);
    }

    #[test]
    fn test_unexpected_id() {
        let mut parser = Parser::new();
        let result = parser.parse(
            "id,CHN201506130
version,2
id,CHN201604110",
        );
        assert_eq!(
            Err(Error::UnexpectedGameId {
                current_game_id: "CHN201506130".into()
            }),
            result
        );
    }

    #[test]
    fn test_unexpected_version() {
        let mut parser = Parser::new();
        let result = parser.parse("version,3");
        assert_eq!(result, Err(Error::NoGame(Event::Version { version: 3 })));
    }

    #[test]
    fn test_bytes_remaining() {
        let mut parser = Parser::new();
        let result = parser.parse(
            "id,CHN201506130
version,2
foo\n\n",
        );
        assert_eq!(Err(Error::StringRemaining("foo\n\n".to_string())), result);
    }

    #[test]
    fn test_reset() {
        let mut parser = Parser::new();
        let _ = parser.parse("id,CHN201506130");
        parser.reset();
        let result = parser.parse(SHORT_GAME);
        assert!(
            result.is_ok(),
            "resetting parser did not allow new game: {}",
            result.err().unwrap()
        );
    }

    #[test]
    fn test_error_printing() {
        let event = Event::Data {
            data_type: DataEventType::EarnedRuns,
            player: "fred103".into(),
            value: "2".into(),
        };
        let bytes = "abc";

        assert_eq!(
            "game_id event was received before finishing game 'foo'".to_string(),
            format!(
                "{}",
                Error::UnexpectedGameId {
                    current_game_id: "foo".into()
                }
            )
        );
        assert_eq!(
            format!(
                "event {:?} was received before a game was registered",
                event
            ),
            format!("{}", Error::NoGame(event.clone()))
        );

        assert_eq!(
            format!("string remaining after parsing completed: {:?}", bytes),
            format!("{}", Error::StringRemaining(bytes.to_string()))
        );

        assert_eq!(
            format!(
                "the event {:?} is not valid in the starting roster parsing state",
                event
            ),
            format!(
                "{}",
                Error::GameProcessingError(GameError::InvalidEvent(
                    GameState::Starters,
                    event.clone()
                ))
            )
        );
    }
}