aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/michelf/php-markdown/test/integration/PhpMarkdownTest.php
blob: ded3a3d120c05f5328727bab75f8363513aa4561 (plain) (blame)
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
<?php

use PHPUnit\Framework\TestCase;
use Michelf\Markdown;
use Michelf\MarkdownExtra;

class PhpMarkdownTest extends TestCase
{
	/**
	 * Returns all php-markdown.mdtest tests
	 * @return array
	 */
	public function dataProviderForPhpMarkdown() {
		$dir = TEST_RESOURCES_ROOT . '/php-markdown.mdtest';
		return MarkdownTestHelper::getInputOutputPaths($dir);
	}

	/**
	 * Runs php-markdown.mdtest against Markdown::defaultTransform
	 *
	 * @dataProvider dataProviderForPhpMarkdown
	 *
	 * @param string $inputPath Input markdown path
	 * @param string $htmlPath File path of expected transformed output (X)HTML
	 *
	 * @param bool $xhtml True if XHTML. Otherwise, HTML is assumed.
	 *
	 * @return void
	 */
	public function testTransformingOfPhpMarkdown($inputPath, $htmlPath, $xhtml = false) {
		$inputMarkdown = file_get_contents($inputPath);
		$expectedHtml = file_get_contents($htmlPath);
		$result = Markdown::defaultTransform($inputMarkdown);

		MarkdownTestHelper::assertSameNormalized(
			$expectedHtml,
			$result,
			"Markdown in $inputPath converts exactly to expected $htmlPath",
			$xhtml
		);
	}

	/**
	 * Returns all php-markdown.mdtest tests EXCEPT Emphasis test.
	 * @return array
	 */
	public function dataProviderForPhpMarkdownExceptEmphasis()
	{
		$dir = TEST_RESOURCES_ROOT . '/php-markdown.mdtest';
		$allTests = MarkdownTestHelper::getInputOutputPaths($dir);

		foreach ($allTests as $index => $test) {
			// Because MarkdownExtra treats underscore emphasis differently, this one test has to be excluded
			if (preg_match('~/Emphasis\.text$~', $test[0])) {
				unset($allTests[$index]);
			}
		}

		return array_values($allTests);
	}

	/**
	 * Runs php-markdown.mdtest against MarkdownExtra::defaultTransform
	 *
	 * @dataProvider dataProviderForPhpMarkdownExceptEmphasis
	 *
	 * @param $inputPath
	 * @param $htmlPath
	 * @param bool $xhtml
	 */
	public function testPhpMarkdownMdTestWithMarkdownExtra($inputPath, $htmlPath, $xhtml = false)
	{
		$inputMarkdown = file_get_contents($inputPath);
		$expectedHtml = file_get_contents($htmlPath);

		$result = MarkdownExtra::defaultTransform($inputMarkdown);

		MarkdownTestHelper::assertSameNormalized(
			$expectedHtml,
			$result,
			"Markdown in $inputPath converts exactly to expected $htmlPath",
			$xhtml
		);
	}

	/**
	 * @return array
	 */
	public function dataProviderForMarkdownExtra() {
		$dir = TEST_RESOURCES_ROOT . '/php-markdown-extra.mdtest';
		return MarkdownTestHelper::getInputOutputPaths($dir);
	}

	/**
	 * @dataProvider dataProviderForMarkdownExtra
	 *
	 * @param string $inputPath Input markdown path
	 * @param string $htmlPath File path of expected transformed output (X)HTML
	 *
	 * @param bool $xhtml True if XHTML. Otherwise, HTML is assumed.
	 *
	 * @return void
	 */
	public function testTransformingOfMarkdownExtra($inputPath, $htmlPath, $xhtml = false) {
		$inputMarkdown = file_get_contents($inputPath);
		$expectedHtml = file_get_contents($htmlPath);
		$result = MarkdownExtra::defaultTransform($inputMarkdown);

		MarkdownTestHelper::assertSameNormalized(
			$expectedHtml,
			$result,
			"Markdown in $inputPath converts exactly to expected $htmlPath",
			$xhtml
		);
	}

	/**
	 * @return array
	 */
	public function dataProviderForRegularMarkdown()
	{
		$dir = TEST_RESOURCES_ROOT . '/markdown.mdtest';
		return MarkdownTestHelper::getInputOutputPaths($dir);
	}

	/**
	 * @dataProvider dataProviderForRegularMarkdown
	 *
	 * @param string $inputPath Input markdown path
	 * @param string $htmlPath File path of expected transformed output (X)HTML
	 *
	 * @param bool $xhtml True if XHTML. Otherwise, HTML is assumed.
	 *
	 * @return void
	 */
	public function testTransformingOfRegularMarkdown($inputPath, $htmlPath, $xhtml = false)
	{
		$inputMarkdown = file_get_contents($inputPath);
		$expectedHtml = file_get_contents($htmlPath);
		$result = Markdown::defaultTransform($inputMarkdown);

		MarkdownTestHelper::assertSameNormalized(
			$expectedHtml,
			$result,
			"Markdown in $inputPath converts exactly to expected $htmlPath",
			$xhtml
		);
	}

	/**
	 * Runs markdown.mdtest against MarkdownExtra::defaultTransform
	 *
	 * @dataProvider dataProviderForRegularMarkdown
	 *
	 * @param $inputPath
	 * @param $htmlPath
	 * @param bool $xhtml
	 */
	public function testMarkdownMdTestWithMarkdownExtra($inputPath, $htmlPath, $xhtml = false)
	{
		$inputMarkdown = file_get_contents($inputPath);
		$expectedHtml = file_get_contents($htmlPath);

		$result = MarkdownExtra::defaultTransform($inputMarkdown);

		MarkdownTestHelper::assertSameNormalized(
			$expectedHtml,
			$result,
			"Markdown in $inputPath converts exactly to expected $htmlPath",
			$xhtml
		);
	}
}