tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 11:05:56 +02:00
Code Issues Projects Releases Wiki Activity
581c7cb53a
silverstripe-docsviewer/tests/DocumentationParserTest.php

407 lines
12 KiB
PHP
Raw Normal View History

ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
<?php
Fixes for unit tests with the latest manifest
2014-09-15 11:47:45 +02:00
ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
/**
MINOR: rename from docviewer to docsviewer
2012-04-08 11:36:16 +02:00
* @package docsviewer
Fixes for unit tests with the latest manifest
2014-09-15 11:47:45 +02:00
* @subpackage tests
ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
*/
Converted to PSR-2
2015-11-21 07:25:41 +01:00
class DocumentationParserTest extends SapphireTest
{
protected $entity, $entityAlt, $page, $subPage, $subSubPage, $filePage, $metaDataPage, $indexPage;
public function tearDown()
{
parent::tearDown();
Config::unnest();
}
public function setUp()
{
parent::setUp();
Config::nest();
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs/'
);
$this->entity = new DocumentationEntity('DocumentationParserTest');
$this->entity->setPath(DOCSVIEWER_PATH . '/tests/docs/en/');
$this->entity->setVersion('2.4');
$this->entity->setLanguage('en');
$this->entityAlt = new DocumentationEntity('DocumentationParserParserTest');
$this->entityAlt->setPath(DOCSVIEWER_PATH . '/tests/docs-parser/en/');
$this->entityAlt->setVersion('2.4');
$this->entityAlt->setLanguage('en');
$this->page = new DocumentationPage(
$this->entity,
'test.md',
DOCSVIEWER_PATH . '/tests/docs/en/test.md'
);
$this->subPage = new DocumentationPage(
$this->entity,
'subpage.md',
DOCSVIEWER_PATH. '/tests/docs/en/subfolder/subpage.md'
);
$this->subSubPage = new DocumentationPage(
$this->entity,
'subsubpage.md',
DOCSVIEWER_PATH. '/tests/docs/en/subfolder/subsubfolder/subsubpage.md'
);
$this->filePage = new DocumentationPage(
$this->entityAlt,
'file-download.md',
DOCSVIEWER_PATH . '/tests/docs-parser/en/file-download.md'
);
$this->metaDataPage = new DocumentationPage(
$this->entityAlt,
'MetaDataTest.md',
DOCSVIEWER_PATH . '/tests/docs-parser/en/MetaDataTest.md'
);
$this->indexPage = new DocumentationPage(
$this->entity,
'index.md',
DOCSVIEWER_PATH. '/tests/docs/en/index.md'
);
$manifest = new DocumentationManifest(true);
}
public function testRewriteCodeBlocks()
{
$codePage = new DocumentationPage(
$this->entityAlt,
'CodeSnippets.md',
DOCSVIEWER_PATH . '/tests/docs-parser/en/CodeSnippets.md'
);
$result = DocumentationParser::rewrite_code_blocks(
$codePage->getMarkdown()
);
$expected = <<<HTML
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
#### <% control Foo %>
```
code block
<% without formatting prefix %>
```
Paragraph with a segment of <% foo %>
```
code block
that has a line in it
```
This is a yaml block
```yaml
foo: bar
baz: qux
```
This is a yaml block with tab in that new line
```yaml
foo: bar
baz: qux
```
HTML;
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$this->assertEquals($expected, $result, 'Code blocks support line breaks');
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$result = DocumentationParser::rewrite_code_blocks(
$this->page->getMarkdown()
);
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$expected = <<<HTML
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
```php
code block
with multiple
lines
and tab indent
and escaped < brackets
```
Normal text after code block
HTML;
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$this->assertContains($expected, $result, 'Custom code blocks with ::: prefix');
$expected = <<<HTML
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
```
code block
without formatting prefix
```
HTML;
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$this->assertContains($expected, $result, 'Traditional markdown code blocks');
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$expected = <<<HTML
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
```
Fenced code block
```
HTML;
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$this->assertContains($expected, $result, 'Backtick code blocks');
$expected = <<<HTML
Change DocumentationParser to use GFM for code
2014-09-26 10:15:40 +02:00
```php
Fenced box with
new lines in
between
content
```
HTML;
Converted to PSR-2
2015-11-21 07:25:41 +01:00
$this->assertContains($expected, $result, 'Backtick with newlines');
}
public function testRelativeLinks()
{
// index.md
$result = DocumentationParser::rewrite_relative_links(
$this->indexPage->getMarkdown(),
$this->indexPage
);
$this->assertContains(
'[link: subfolder index](dev/docs/en/documentationparsertest/2.4/subfolder/)',
$result
);
// test.md
$result = DocumentationParser::rewrite_relative_links(
$this->page->getMarkdown(),
$this->page
);
$this->assertContains(
'[link: subfolder index](dev/docs/en/documentationparsertest/2.4/subfolder/)',
$result
);
$this->assertContains(
'[link: subfolder page](dev/docs/en/documentationparsertest/2.4/subfolder/subpage/)',
$result
);
$this->assertContains(
'[link: http](http://silverstripe.org)',
$result
);
$result = DocumentationParser::rewrite_relative_links(
$this->subPage->getMarkdown(),
$this->subPage
);
# @todo this should redirect to /subpage/
$this->assertContains(
'[link: relative](dev/docs/en/documentationparsertest/2.4/subfolder/subpage.md/)',
$result
);
$this->assertContains(
'[link: absolute index](dev/docs/en/documentationparsertest/2.4/)',
$result
);
# @todo this should redirect to /
$this->assertContains(
'[link: absolute index with name](dev/docs/en/documentationparsertest/2.4/index/)',
$result
);
$this->assertContains(
'[link: relative index](dev/docs/en/documentationparsertest/2.4/)',
$result
);
$this->assertContains(
'[link: relative parent page](dev/docs/en/documentationparsertest/2.4/test/)',
$result
);
$this->assertContains(
'[link: absolute parent page](dev/docs/en/documentationparsertest/2.4/test/)',
$result
);
$result = DocumentationParser::rewrite_relative_links(
$this->subSubPage->getMarkdown(),
$this->subSubPage
);
$this->assertContains(
'[link: absolute index](dev/docs/en/documentationparsertest/2.4/)',
$result
);
$this->assertContains(
'[link: relative index](dev/docs/en/documentationparsertest/2.4/subfolder/)',
$result
);
$this->assertContains(
'[link: relative parent page](dev/docs/en/documentationparsertest/2.4/subfolder/subpage/)',
$result
);
$this->assertContains(
'[link: relative grandparent page](dev/docs/en/documentationparsertest/2.4/test/)',
$result
);
$this->assertContains(
'[link: absolute page](dev/docs/en/documentationparsertest/2.4/test/)',
$result
);
}
public function testGenerateHtmlId()
{
$this->assertEquals('title-one', DocumentationParser::generate_html_id('title one'));
$this->assertEquals('title-one', DocumentationParser::generate_html_id('Title one'));
$this->assertEquals('title-and-one', DocumentationParser::generate_html_id('Title &amp; One'));
$this->assertEquals('title-and-one', DocumentationParser::generate_html_id('Title & One'));
$this->assertEquals('title-one', DocumentationParser::generate_html_id(' Title one '));
$this->assertEquals('title-one', DocumentationParser::generate_html_id('Title--one'));
}
public function testImageRewrites()
{
$result = DocumentationParser::rewrite_image_links(
$this->subPage->getMarkdown(),
$this->subPage
);
$expected = Controller::join_links(
Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/subfolder/_images/image.png'
);
$this->assertContains(
sprintf('[relative image link](%s)', $expected),
$result
);
$this->assertContains(
sprintf('[parent image link](%s)', Controller::join_links(
Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/_images/image.png'
)),
$result
);
$expected = Controller::join_links(
Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/_images/image.png'
);
$this->assertContains(
sprintf('[absolute image link](%s)', $expected),
$result
);
}
public function testApiLinks()
{
FIXED Api shortcode references and updated tests temporarily commented out asserts in unrelated tests typo in comment pffffft...whitespace double pffffft.....whitespace triple pffffft.....whitespace
2016-01-21 01:15:50 +01:00
// $this->page is test.md, the documentation page being parsed by rewrite_api_links
$parsed_page = DocumentationParser::rewrite_api_links($this->page->getMarkdown(), $this->page);
// version of documentation page
$page_version = $this->page->getVersion();
// expected url format resulting from rewriting api shortcode links
Further tidy up of api link parsing and testing typo another typo ANOTHER typo update tests fixed regexs resolving test failures resolving test failures tidy up test tidy up refined regexs, output formatting, and tests further refined regexs typo in comments whitespace comment
2016-01-23 02:42:42 +01:00
$html_format = '<a href="http://api.silverstripe.org/search/lookup/?q=%s&version='.$page_version.'&module=documentationparsertest">%s</a>';
FIXED Api shortcode references and updated tests temporarily commented out asserts in unrelated tests typo in comment pffffft...whitespace double pffffft.....whitespace triple pffffft.....whitespace
2016-01-21 01:15:50 +01:00
Further tidy up of api link parsing and testing typo another typo ANOTHER typo update tests fixed regexs resolving test failures resolving test failures tidy up test tidy up refined regexs, output formatting, and tests further refined regexs typo in comments whitespace comment
2016-01-23 02:42:42 +01:00
// test cases: non-backtick enclosed api links and the expected html resulting from rewriting them
// note that api links enclosed in backticks are left unchanged
FIXED Api shortcode references and updated tests temporarily commented out asserts in unrelated tests typo in comment pffffft...whitespace double pffffft.....whitespace triple pffffft.....whitespace
2016-01-21 01:15:50 +01:00
$test_cases = array(
Further tidy up of api link parsing and testing typo another typo ANOTHER typo update tests fixed regexs resolving test failures resolving test failures tidy up test tidy up refined regexs, output formatting, and tests further refined regexs typo in comments whitespace comment
2016-01-23 02:42:42 +01:00
array('`[api:DataObject]`','`[api:DataObject]`'),
array('`[api:DataObject::$defaults]`','`[api:DataObject::$defaults]`'),
array('`[api:DataObject::populateDefaults()]`','`[api:DataObject::populateDefaults()]`'),
array('`[Title](api:DataObject)`','`[Title](api:DataObject)`'),
array('`[Title](api:DataObject::$defaults)`','`[Title](api:DataObject::$defaults)`'),
array('`[Title](api:DataObject::populateDefaults())`','`[Title](api:DataObject::populateDefaults())`'),
array('[api:DataObject]', sprintf($html_format,'DataObject','DataObject')),
array('[api:DataObject::$defaults]',sprintf($html_format,'DataObject::$defaults','DataObject::$defaults')),
array('[api:DataObject::populateDefaults()]',sprintf($html_format,'DataObject::populateDefaults()','DataObject::populateDefaults()')),
array('[Title](api:DataObject)',sprintf($html_format,'DataObject','Title')),
array('[Title](api:DataObject::$defaults)',sprintf($html_format,'DataObject::$defaults','Title')),
array('[Title](api:DataObject::populateDefaults())',sprintf($html_format,'DataObject::populateDefaults()','Title'))
Converted to PSR-2
2015-11-21 07:25:41 +01:00
);
FIXED Api shortcode references and updated tests temporarily commented out asserts in unrelated tests typo in comment pffffft...whitespace double pffffft.....whitespace triple pffffft.....whitespace
2016-01-21 01:15:50 +01:00
foreach($test_cases as $test_case) {
Further tidy up of api link parsing and testing typo another typo ANOTHER typo update tests fixed regexs resolving test failures resolving test failures tidy up test tidy up refined regexs, output formatting, and tests further refined regexs typo in comments whitespace comment
2016-01-23 02:42:42 +01:00
$expected_html = $test_case[1];
$this->assertContains($expected_html,$parsed_page);
FIXED Api shortcode references and updated tests temporarily commented out asserts in unrelated tests typo in comment pffffft...whitespace double pffffft.....whitespace triple pffffft.....whitespace
2016-01-21 01:15:50 +01:00
}
Converted to PSR-2
2015-11-21 07:25:41 +01:00
}
public function testHeadlineAnchors()
{
$result = DocumentationParser::rewrite_heading_anchors(
$this->page->getMarkdown(),
$this->page
);
/*
# Heading one {#Heading-one}
# Heading with custom anchor {#custom-anchor} {#Heading-with-custom-anchor-custom-anchor}
## Heading two {#Heading-two}
### Heading three {#Heading-three}
## Heading duplicate {#Heading-duplicate}
## Heading duplicate {#Heading-duplicate-2}
## Heading duplicate {#Heading-duplicate-3}
*/
$this->assertContains('# Heading one {#heading-one}', $result);
$this->assertContains('# Heading with custom anchor {#custom-anchor}', $result);
$this->assertNotContains('# Heading with custom anchor {#custom-anchor} {#heading', $result);
$this->assertContains('# Heading two {#heading-two}', $result);
$this->assertContains('# Heading three {#heading-three}', $result);
$this->assertContains('## Heading duplicate {#heading-duplicate}', $result);
$this->assertContains('## Heading duplicate {#heading-duplicate-2}', $result);
$this->assertContains('## Heading duplicate {#heading-duplicate-3}', $result);
}
public function testRetrieveMetaData()
{
DocumentationParser::retrieve_meta_data($this->metaDataPage);
$this->assertEquals('Dr. Foo Bar.', $this->metaDataPage->author);
$this->assertEquals("Foo Bar's Test page.", $this->metaDataPage->getTitle());
}
public function testRewritingRelativeLinksToFiles()
{
$parsed = DocumentationParser::parse($this->filePage);
$this->assertContains(
DOCSVIEWER_DIR .'/tests/docs-parser/en/_images/external_link.png',
$parsed
);
$this->assertContains(
DOCSVIEWER_DIR .'/tests/docs-parser/en/_images/test.tar.gz',
$parsed
);
}
}
Reference in New Issue Copy Permalink