twas 1.1.0

A text substitution application for using random look-up tables to generate text in a manner similar to the Mad Libs game.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

#![deny(unused_must_use)]
#![deny(missing_docs)]
use serde::{Deserialize, Serialize};

/// Struct to hold all the possible substitution options for a substitution token
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct SubstitutionOptions {
	/// ID of the lookup table to apply
	pub id: String,
	/// Option to specify number of items to draw from the lookup table. Can be either a number or
	/// a dice expression (eg "2d6+3" meaning 'roll two 6-sided dice and then add 3 to the total')
	pub count: Option<serde_yaml_neo::Value>,
	/// If drawing more than one, what method to use. Either "random" for unbiased random draw or
	/// "shuffle" to avoid drawing the same item twice (until all items are used)
	pub method: Option<String>,
	/// If drawing more than one item, separate them with this string
	pub sep: Option<String>,
	/// If drawing more than one item, separate the last two with this string instead of `sep`
	#[serde(rename = "last-sep")]
	pub last_sep: Option<String>,
	/// Prefix this string before each item
	pub prefix: Option<String>,
	/// Postfix this string after each item
	pub suffix: Option<String>,
	/// Specify text capitalization. Must be one of: "upper", "lower", "title", "first", "original"
	pub case: Option<String>,
	/// References allow for re-use of the same substitution with the @ref syntax
	#[serde(rename = "ref")]
	pub reference: Option<String>,
	/// If set to true, do not render this item (useful for references)
	pub hidden: Option<bool>,
	/// If set to true, prefix with correct english indefinite article (a/an)
	pub aan: Option<bool>,
}

impl SubstitutionOptions {
	/// Constructs a new `SubstitutionOptions` with default values
	pub fn new(id: &str) -> Self {
		SubstitutionOptions {
			id: String::from(id),
			count: None,
			method: None,
			sep: None,
			last_sep: None,
			prefix: None,
			suffix: None,
			case: None,
			reference: None,
			hidden: None,
			aan: None,
		}
	}
	/// Constructs a new `SubstitutionOptions` with default values plus a reference ID
	pub fn new_with_ref(id: &str, ref_name: &str) -> Self {
		SubstitutionOptions {
			id: String::from(id),
			count: None,
			method: None,
			sep: None,
			last_sep: None,
			prefix: None,
			suffix: None,
			case: None,
			reference: Some(ref_name.to_string()),
			hidden: None,
			aan: None,
		}
	}
}

#[cfg(test)]
mod unit_tests {
	use crate::subspec::SubstitutionOptions;

	#[test]
	fn test_serde_parse_1() {
		let sub_spec: SubstitutionOptions = serde_yaml_neo::from_str(
			r#"{"id": "animals.plural", "count": 3, "method": "shuffle", "sep": ", ", "last-sep": ", and "}"#
		).expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animals.plural");
		assert_eq!(
			sub_spec.count,
			Some(serde_yaml_neo::Value::Number(serde_yaml_neo::Number::from(3)))
		);
		assert_eq!(sub_spec.method, Some(String::from("shuffle")));
		assert_eq!(sub_spec.sep, Some(String::from(", ")));
		assert_eq!(sub_spec.last_sep, Some(String::from(", and ")));
		assert!(sub_spec.prefix.is_none());
		assert!(sub_spec.suffix.is_none());
		assert!(sub_spec.case.is_none());
		assert!(sub_spec.reference.is_none());
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
	#[test]
	fn test_serde_parse_2() {
		let sub_spec: SubstitutionOptions = serde_yaml_neo::from_str(
			r#"{"id": "animals.plural", "count": "1d4+1", "method": "random", "sep": ", ", "last-sep": ", and "}"#
		).expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animals.plural");
		assert_eq!(
			sub_spec.count,
			Some(serde_yaml_neo::Value::String(String::from("1d4+1")))
		);
		assert_eq!(sub_spec.method, Some(String::from("random")));
		assert_eq!(sub_spec.sep, Some(String::from(", ")));
		assert_eq!(sub_spec.last_sep, Some(String::from(", and ")));
		assert!(sub_spec.prefix.is_none());
		assert!(sub_spec.suffix.is_none());
		assert!(sub_spec.case.is_none());
		assert!(sub_spec.reference.is_none());
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
	#[test]
	fn test_serde_parse_2b() {
		let sub_spec: SubstitutionOptions = serde_yaml_neo::from_str(
			r#"{id: animals.plural, count: 1d4+1, method: random, sep: ", ", last-sep: ", and "}"#,
		)
		.expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animals.plural");
		assert_eq!(
			sub_spec.count,
			Some(serde_yaml_neo::Value::String(String::from("1d4+1")))
		);
		assert_eq!(sub_spec.method, Some(String::from("random")));
		assert_eq!(sub_spec.sep, Some(String::from(", ")));
		assert_eq!(sub_spec.last_sep, Some(String::from(", and ")));
		assert!(sub_spec.prefix.is_none());
		assert!(sub_spec.suffix.is_none());
		assert!(sub_spec.case.is_none());
		assert!(sub_spec.reference.is_none());
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
	#[test]
	fn test_serde_parse_3() {
		let sub_spec: SubstitutionOptions =
			serde_yaml_neo::from_str(r#"{"id": "animals.plural"}"#).expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animals.plural");
		assert!(sub_spec.count.is_none());
		assert!(sub_spec.method.is_none());
		assert!(sub_spec.sep.is_none());
		assert!(sub_spec.last_sep.is_none());
		assert!(sub_spec.prefix.is_none());
		assert!(sub_spec.suffix.is_none());
		assert!(sub_spec.case.is_none());
		assert!(sub_spec.reference.is_none());
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
	#[test]
	fn test_serde_parse_4() {
		let sub_spec: SubstitutionOptions = serde_yaml_neo::from_str(
			r#"{"id": "animals.plural", "count": 3, "prefix": " * ", "suffix": "\n", "case": "first"}"#,
		)
		.expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animals.plural");
		assert_eq!(
			sub_spec.count,
			Some(serde_yaml_neo::Value::Number(serde_yaml_neo::Number::from(3)))
		);
		assert!(sub_spec.method.is_none());
		assert!(sub_spec.sep.is_none());
		assert!(sub_spec.last_sep.is_none());
		assert_eq!(sub_spec.prefix, Some(String::from(" * ")));
		assert_eq!(sub_spec.suffix, Some(String::from("\n")));
		assert_eq!(sub_spec.case, Some(String::from("first")));
		assert!(sub_spec.reference.is_none());
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
	#[test]
	fn test_serde_parse_5() {
		let sub_spec: SubstitutionOptions =
			serde_yaml_neo::from_str(r#"{"id": "animal", "ref": "pet"}"#).expect("Failed to parse");
		assert_eq!(sub_spec.id.as_str(), "animal");
		assert!(sub_spec.count.is_none());
		assert!(sub_spec.method.is_none());
		assert!(sub_spec.sep.is_none());
		assert!(sub_spec.last_sep.is_none());
		assert!(sub_spec.prefix.is_none());
		assert!(sub_spec.suffix.is_none());
		assert!(sub_spec.case.is_none());
		assert_eq!(sub_spec.reference, Some(String::from("pet")));
		assert!(sub_spec.hidden.is_none());
		assert!(sub_spec.aan.is_none());
	}
}