nightrunner_lib 0.4.0

A parser library for making text adventure games
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

use std::collections::HashMap;

use super::*;
use crate::{
    config::{Config, State},
    parser::interpreter::{EventMessage, MessageParts},
};
#[cfg(test)]
use pretty_assertions::assert_eq;

#[test]
fn it_parses_single_verb() {
    let config = Config::from_path("fixtures/").unwrap();
    let state = State::init(config);
    let mut result = parse(&state, "quit");
    assert_eq!(result.unwrap().1, ParsingResult::Quit);

    result = parse(&state, "look");
    assert_eq!(
        result.unwrap().1,
        ParsingResult::Look(
            "first room\n\nHere you see: \nan item1\nan item2\nsubject1".to_string()
        )
    );
}
#[test]
fn it_parses_verb_and_item_or_subject() {
    let config = Config::from_path("fixtures/").unwrap();
    let state = State::init(config);
    let mut result = parse(&state, "take item2");
    let mut message_parts = HashMap::new();
    assert!(result.is_ok());
    let (new_state, parsing_result) = result.unwrap();
    assert_eq!(
        parsing_result,
        ParsingResult::NewItem("\nYou now have a item2\n".to_string())
    );
    assert_eq!(
        new_state.player.inventory.items[0].name,
        "item2".to_string()
    );

    result = parse(&new_state, "talk subject1");
    let (new_state, parsing_result) = result.unwrap();
    message_parts.insert(MessageParts::RoomText, "text".to_string());
    message_parts.insert(MessageParts::EventText, "".to_string());
    message_parts.insert(
        MessageParts::Exits,
        "Exits:\nto the south you see second room".to_string(),
    );
    assert_eq!(
        parsing_result,
        ParsingResult::EventSuccess(EventMessage {
            message: "text\n\n\nExits:\nto the south you see second room".to_string(),
            templated_words: vec![],
            message_parts: message_parts.clone(),
        })
    );

    result = parse(&new_state, "go south");
    let (new_state, parsing_result) = result.unwrap();
    message_parts.insert(MessageParts::RoomText, "this is a templated which exists in the game item3.\n\nthis is a templated subject that exists in the game subject2.".to_string());
    message_parts.insert(MessageParts::EventText, "".to_string());
    message_parts.insert(
        MessageParts::Exits,
        "Exits:\nto the north you see first room".to_string(),
    );
    assert_eq!(
        parsing_result,
        ParsingResult::EventSuccess(EventMessage {
            message: "this is a templated which exists in the game item3.\n\nthis is a templated subject that exists in the game subject2.\n\n\nExits:\nto the north you see first room".to_string(),
            templated_words: vec!["item3".to_string(), "subject2".to_string()],
            message_parts,
        })
    );

    result = parse(&new_state, "give item2 to subject2");
    // There is no event for player giving item2 to subject2
    // so we expect an error. InvalidEvent should be used to
    // indicate that the event is not valid, and how to handle
    // this error is up to the front-end. Perhaps you display
    // a message to the user saying that this action is invalid,
    // or you don't understand the command.
    // For convenience, this error wraps the action as it was
    // interpreted by the parser from the input. This is useful
    // when writing custom logic for the front-end.
    assert_eq!(
        result.unwrap().1,
        ParsingResult::SubjectNoEvent("default text".to_string()),
    );
}