collagen 0.9.5

The collage generator
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

use collagen::{cli::ProvidedInput, Fibroblast};
use quick_xml::Writer as XmlWriter;
use std::path::{Path, PathBuf};

#[track_caller]
fn test_clgn_against_existing_output(clgn_path: impl AsRef<Path>, out_path: impl AsRef<Path>) {
	let clgn_path = clgn_path.as_ref();
	let out_path = out_path.as_ref();

	let mut fibroblast_bytes = Vec::<u8>::new();
	let mut xml_writer = XmlWriter::new(&mut fibroblast_bytes);

	let fibroblast = Fibroblast::from_dir(ProvidedInput::Folder(clgn_path), None).unwrap();
	fibroblast.to_svg(&mut xml_writer).unwrap();

	let out_bytes = std::fs::read(out_path).unwrap();

	if fibroblast_bytes != out_bytes {
		let f = tempfile::NamedTempFile::with_suffix(".svg").unwrap();
		let path = f.path().to_owned();

		std::fs::write(&path, fibroblast_bytes).unwrap();
		std::mem::forget(f); // don't delete file after test runs and program exits

		// not assert_eq because on failure, the debug representations are long and useless
		panic!(
			"Collagen generated from input did not match expected output. \
			 Input (actual) path: {clgn_path:?}. \
			 Output (expected) path: {out_path:?}. \
			 Generated output written to {path:?}",
		);
	}
}

macro_rules! test_input_output {
	($name:ident, $test_folder:expr $(,)?) => {
		test_input_output!($name, $test_folder, "skeleton" => "out.svg");
	};
	($name:ident, $test_folder:expr, pass_if: $attr_to_pass:meta, fail_if: $attr_to_fail:meta $(,)?) => {
		test_input_output!(
			$name,
			$test_folder,
			"skeleton" => "out.svg",
			pass_if: $attr_to_pass,
			fail_if: $attr_to_fail,
		);
	};
	($name:ident, $test_folder:expr, $skeleton_rel_path:expr => $out_path:expr $(,)?) => {
		mod $name {
			use super::*;

			#[track_caller]
			fn _test_it() {
				test_clgn_against_existing_output(
					PathBuf::from($test_folder).join($skeleton_rel_path),
					PathBuf::from($test_folder).join($out_path)
				);
			}

			#[test]
			fn test() {
				_test_it()
			}

			// #[bench]
			// fn bench(b: &mut Bencher) {
			// 	b.iter(_test_it);
			// }
		}
	};
	(
		$name:ident,
		$test_folder:expr,
		$skeleton_rel_path:expr => $out_path:expr,
		pass_if: $attr_to_pass:meta,
		fail_if: $attr_to_fail:meta $(,)?
	) => {
		mod $name {
			use super::*;

			#[track_caller]
			fn _test_it() {
				test_clgn_against_existing_output(
					PathBuf::from($test_folder).join($skeleton_rel_path),
					PathBuf::from($test_folder).join($out_path)
				);
			}

			#[$attr_to_pass]
			#[test]
			fn test() {
				_test_it()
			}

			#[$attr_to_fail]
			#[should_panic]
			#[test]
			fn test() {
				_test_it()
			}

			// #[bench]
			// fn bench(b: &mut Bencher) {
			// 	b.iter(_test_it);
			// }
		}
	};
}

#[cfg(test)]
mod examples {
	use super::*;

	test_input_output!(empty, "./tests/examples/empty");
	test_input_output!(basic_smiley, "./tests/examples/basic-smiley-pure-svg");
	test_input_output!(
		smiley_with_speech_bubble,
		"./tests/examples/kitty-nesting-smiley/skeleton/smiley"
	);
	test_input_output!(kitty_nested_smiley, "./tests/examples/kitty-nesting-smiley");
	test_input_output!(random_gibberish, "./tests/examples/random-gibberish");
	test_input_output!(
		simple_nesting, "./tests/examples/simple-nesting", "A" => "out.svg"
	);

	test_input_output!(
		drake_user_specified_font,
		"./tests/examples/drake-user-specified-font"
	);
	test_input_output!(
		drake_user_specified_font_loop,
		"./tests/examples/drake-user-specified-font-loop"
	);
	test_input_output!(
		drake_bundled_font,
		"./tests/examples/drake-bundled-font",
		pass_if: cfg(feature ="font_impact"),
		fail_if: cfg(not(feature = "font_impact"))
	);
	test_input_output!(
		drake_manually_specified_font,
		"./tests/examples/drake-manually-specified-font"
	);
	test_input_output!(drake_no_font, "./tests/examples/drake-no-font");
}