Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generators: add tests covering handling of invalid docs #794

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Generators: add tests covering handling of invalid docs #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions src/Generators/HTML.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,20 +383,27 @@ protected function printCodeComparisonBlock(DOMNode $node)
*/
protected function getFormattedCodeComparisonBlock(DOMNode $node)
{
$codeBlocks = $node->getElementsByTagName('code');
$codeBlocks = $node->getElementsByTagName('code');
$firstCodeElm = $codeBlocks->item(0);
$secondCodeElm = $codeBlocks->item(1);

$firstTitle = trim($codeBlocks->item(0)->getAttribute('title'));
if (isset($firstCodeElm, $secondCodeElm) === false) {
// Missing at least one code block.
return '';
}

$firstTitle = trim($firstCodeElm->getAttribute('title'));
$firstTitle = str_replace(' ', '  ', $firstTitle);
$first = trim($codeBlocks->item(0)->nodeValue);
$first = trim($firstCodeElm->nodeValue);
$first = str_replace('<?php', '&lt;?php', $first);
$first = str_replace("\n", '</br>', $first);
$first = str_replace(' ', '&nbsp;', $first);
$first = str_replace('<em>', '<span class="code-comparison-highlight">', $first);
$first = str_replace('</em>', '</span>', $first);

$secondTitle = trim($codeBlocks->item(1)->getAttribute('title'));
$secondTitle = trim($secondCodeElm->getAttribute('title'));
$secondTitle = str_replace(' ', '&nbsp;&nbsp;', $secondTitle);
$second = trim($codeBlocks->item(1)->nodeValue);
$second = trim($secondCodeElm->nodeValue);
$second = str_replace('<?php', '&lt;?php', $second);
$second = str_replace("\n", '</br>', $second);
$second = str_replace(' ', '&nbsp;', $second);
Expand Down
17 changes: 12 additions & 5 deletions src/Generators/Markdown.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,18 +241,25 @@ protected function printCodeComparisonBlock(DOMNode $node)
*/
protected function getFormattedCodeComparisonBlock(DOMNode $node)
{
$codeBlocks = $node->getElementsByTagName('code');
$codeBlocks = $node->getElementsByTagName('code');
$firstCodeElm = $codeBlocks->item(0);
$secondCodeElm = $codeBlocks->item(1);

$firstTitle = trim($codeBlocks->item(0)->getAttribute('title'));
if (isset($firstCodeElm, $secondCodeElm) === false) {
// Missing at least one code block.
return '';
}

$firstTitle = trim($firstCodeElm->getAttribute('title'));
$firstTitle = str_replace(' ', '&nbsp;&nbsp;', $firstTitle);
$first = trim($codeBlocks->item(0)->nodeValue);
$first = trim($firstCodeElm->nodeValue);
$first = str_replace("\n", PHP_EOL.' ', $first);
$first = str_replace('<em>', '', $first);
$first = str_replace('</em>', '', $first);

$secondTitle = trim($codeBlocks->item(1)->getAttribute('title'));
$secondTitle = trim($secondCodeElm->getAttribute('title'));
$secondTitle = str_replace(' ', '&nbsp;&nbsp;', $secondTitle);
$second = trim($codeBlocks->item(1)->nodeValue);
$second = trim($secondCodeElm->nodeValue);
$second = str_replace("\n", PHP_EOL.' ', $second);
$second = str_replace('<em>', '', $second);
$second = str_replace('</em>', '', $second);
Expand Down
18 changes: 13 additions & 5 deletions src/Generators/Text.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,17 @@ protected function printCodeComparisonBlock(DOMNode $node)
*/
protected function getFormattedCodeComparisonBlock(DOMNode $node)
{
$codeBlocks = $node->getElementsByTagName('code');
$first = trim($codeBlocks->item(0)->nodeValue);
$firstTitle = trim($codeBlocks->item(0)->getAttribute('title'));
$codeBlocks = $node->getElementsByTagName('code');
$firstCodeElm = $codeBlocks->item(0);
$secondCodeElm = $codeBlocks->item(1);

if (isset($firstCodeElm, $secondCodeElm) === false) {
// Missing at least one code block.
return '';
}

$first = trim($firstCodeElm->nodeValue);
$firstTitle = trim($firstCodeElm->getAttribute('title'));

$firstTitleLines = [];
$tempTitle = '';
Expand Down Expand Up @@ -234,8 +242,8 @@ protected function getFormattedCodeComparisonBlock(DOMNode $node)
$first = str_replace('</em>', '', $first);
$firstLines = explode("\n", $first);

$second = trim($codeBlocks->item(1)->nodeValue);
$secondTitle = trim($codeBlocks->item(1)->getAttribute('title'));
$second = trim($secondCodeElm->nodeValue);
$secondTitle = trim($secondCodeElm->getAttribute('title'));

$secondTitleLines = [];
$tempTitle = '';
Expand Down
88 changes: 88 additions & 0 deletions ...s/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<html>
<head>
<title>GeneratorTest Coding Standards</title>
<style>
body {
background-color: #FFFFFF;
font-size: 14px;
font-family: Arial, Helvetica, sans-serif;
color: #000000;
}

h1 {
color: #666666;
font-size: 20px;
font-weight: bold;
margin-top: 0px;
background-color: #E6E7E8;
padding: 20px;
border: 1px solid #BBBBBB;
}

h2 {
color: #00A5E3;
font-size: 16px;
font-weight: normal;
margin-top: 50px;
}

.code-comparison {
width: 100%;
}

.code-comparison td {
border: 1px solid #CCCCCC;
}

.code-comparison-title, .code-comparison-code {
font-family: Arial, Helvetica, sans-serif;
font-size: 12px;
color: #000000;
vertical-align: top;
padding: 4px;
width: 50%;
background-color: #F1F1F1;
line-height: 15px;
}

.code-comparison-code {
font-family: Courier;
background-color: #F9F9F9;
}

.code-comparison-highlight {
background-color: #DDF1F7;
border: 1px solid #00A5E3;
line-height: 15px;
}

.tag-line {
text-align: center;
width: 100%;
margin-top: 30px;
font-size: 12px;
}

.tag-line a {
color: #000000;
}
</style>
</head>
<body>
<h1>GeneratorTest Coding Standards</h1>
<a name="Code-Comparison,-mismatched-code-blocks" />
<h2>Code Comparison, mismatched code blocks</h2>
<p class="text">This doc has two code elements, one only has a title, one has actual code. Unbalanced</p>
<table class="code-comparison">
<tr>
<td class="code-comparison-title">Code title</td>
<td class="code-comparison-title"></td>
</tr>
<tr>
<td class="code-comparison-code"></td>
<td class="code-comparison-code">$a&nbsp;=&nbsp;'Example&nbsp;code';</td>
</tr>
</table>
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
</body>
</html>
25 changes: 25 additions & 0 deletions ...enerators/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# GeneratorTest Coding Standard

## Code Comparison, mismatched code blocks

This doc has two code elements, one only has a title, one has actual code. Unbalanced
<table>
<tr>
<th>Code title</th>
<th></th>
</tr>
<tr>
<td>



</td>
<td>

$a = 'Example code';

</td>
</tr>
</table>

Documentation generated on *REDACTED* by [PHP_CodeSniffer *VERSION*](https://github.com/PHPCSStandards/PHP_CodeSniffer)
13 changes: 13 additions & 0 deletions tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

--------------------------------------------------------------------------
| GENERATORTEST CODING STANDARD: CODE COMPARISON, MISMATCHED CODE BLOCKS |
--------------------------------------------------------------------------

This doc has two code elements, one only has a title, one has actual code. Unbalanced

----------------------------------------- CODE COMPARISON ------------------------------------------
| Code title | |
----------------------------------------------------------------------------------------------------
| | $a = 'Example code'; |
----------------------------------------------------------------------------------------------------

78 changes: 78 additions & 0 deletions tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<html>
<head>
<title>GeneratorTest Coding Standards</title>
<style>
body {
background-color: #FFFFFF;
font-size: 14px;
font-family: Arial, Helvetica, sans-serif;
color: #000000;
}

h1 {
color: #666666;
font-size: 20px;
font-weight: bold;
margin-top: 0px;
background-color: #E6E7E8;
padding: 20px;
border: 1px solid #BBBBBB;
}

h2 {
color: #00A5E3;
font-size: 16px;
font-weight: normal;
margin-top: 50px;
}

.code-comparison {
width: 100%;
}

.code-comparison td {
border: 1px solid #CCCCCC;
}

.code-comparison-title, .code-comparison-code {
font-family: Arial, Helvetica, sans-serif;
font-size: 12px;
color: #000000;
vertical-align: top;
padding: 4px;
width: 50%;
background-color: #F1F1F1;
line-height: 15px;
}

.code-comparison-code {
font-family: Courier;
background-color: #F9F9F9;
}

.code-comparison-highlight {
background-color: #DDF1F7;
border: 1px solid #00A5E3;
line-height: 15px;
}

.tag-line {
text-align: center;
width: 100%;
margin-top: 30px;
font-size: 12px;
}

.tag-line a {
color: #000000;
}
</style>
</head>
<body>
<h1>GeneratorTest Coding Standards</h1>
<a name="Code-Comparison,-missing-code-element" />
<h2>Code Comparison, missing code element</h2>
<p class="text">This is a standard block.</p>
<div class="tag-line">Documentation generated on #REDACTED# by <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer">PHP_CodeSniffer #VERSION#</a></div>
</body>
</html>
7 changes: 7 additions & 0 deletions ...re/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# GeneratorTest Coding Standard

## Code Comparison, missing code element

This is a standard block.

Documentation generated on *REDACTED* by [PHP_CodeSniffer *VERSION*](https://github.com/PHPCSStandards/PHP_CodeSniffer)
7 changes: 7 additions & 0 deletions tests/Core/Generators/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

------------------------------------------------------------------------
| GENERATORTEST CODING STANDARD: CODE COMPARISON, MISSING CODE ELEMENT |
------------------------------------------------------------------------

This is a standard block.

Loading
Loading