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
24f1b13233
silverstripe-docsviewer/tests/DocumentationParserTest.php

199 lines
6.2 KiB
PHP
Raw Normal View History

ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
<?php
/**
* @package sapphiredocs
*/
class DocumentationParserTest extends SapphireTest {
FEATURE Parsing of API links
2010-08-01 06:46:37 +02:00
FEATURE <pre> formatting for markdown with custom brush support (:::php to <pre class="brush: php">)
2011-01-10 10:18:44 +01:00
function testRewriteCodeBlocks() {
$page = new DocumentationPage();
$page->setRelativePath('test.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
$page->setLang('en');
$page->setVersion('2.4');
$result = DocumentationParser::rewrite_code_blocks($page->getMarkdown());
$expected = <<<HTML
<pre class="brush: php">
code block
with multiple
lines
and tab indent
BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags
2011-01-10 11:59:22 +01:00
and escaped &lt; brackets
FEATURE <pre> formatting for markdown with custom brush support (:::php to <pre class="brush: php">)
2011-01-10 10:18:44 +01:00
</pre>
BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags
2011-01-10 11:59:22 +01:00
Normal text after code block
FEATURE <pre> formatting for markdown with custom brush support (:::php to <pre class="brush: php">)
2011-01-10 10:18:44 +01:00
HTML;
BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags
2011-01-10 11:59:22 +01:00
$this->assertContains($expected, $result, 'Custom code blocks with ::: prefix');
$expected = <<<HTML
<pre>
code block
without formatting prefix
</pre>
HTML;
$this->assertContains($expected, $result, 'Traditional markdown code blocks');
FEATURE <pre> formatting for markdown with custom brush support (:::php to <pre class="brush: php">)
2011-01-10 10:18:44 +01:00
}
ENHANCEMENT Started code block parser (still needs work)
2010-08-01 23:13:40 +02:00
FEATURE Rewrite image links ENHANCEMENT Return string from parser (instead of HTMLText dependency)
2010-08-01 10:25:00 +02:00
function testImageRewrites() {
// Page on toplevel
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('subfolder/subpage.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
$page->setLang('en');
$page->setVersion('2.4');
FEATURE Rewrite image links ENHANCEMENT Return string from parser (instead of HTMLText dependency)
2010-08-01 10:25:00 +02:00
$result = DocumentationParser::rewrite_image_links($page->getMarkdown(), $page, 'mycontroller/cms/2.4/en/');
ENHANCEMENT: cleaned up logic around Link() and Path() attributes throughout. FEATURE: added search pagination and rough templates for the search results
2010-12-22 09:21:49 +01:00
FEATURE Rewrite image links ENHANCEMENT Return string from parser (instead of HTMLText dependency)
2010-08-01 10:25:00 +02:00
$this->assertContains(
'[relative image link](' . Director::absoluteBaseURL() . '/sapphiredocs/tests/docs/en/subfolder/_images/image.png)',
$result
);
$this->assertContains(
'[parent image link](' . Director::absoluteBaseURL() . '/sapphiredocs/tests/docs/en/_images/image.png)',
$result
);
// TODO Fix absolute image references
// $this->assertContains(
// '[absolute image link](' . Director::absoluteBaseURL() . '/sapphiredocs/tests/docs/en/_images/image.png)',
// $result
// );
}
FEATURE Parsing of API links
2010-08-01 06:46:37 +02:00
function testApiLinks() {
// Page on toplevel
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('test.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
$page->setLang('en');
$page->setVersion('2.4');
FEATURE Parsing of API links
2010-08-01 06:46:37 +02:00
$result = DocumentationParser::rewrite_api_links($page->getMarkdown(), $page, 'mycontroller/cms/2.4/en/');
$this->assertContains(
'[link: api](http://api.silverstripe.org/search/lookup/?q=DataObject&version=2.4&module=mymodule)',
$result
);
$this->assertContains( '[DataObject::$has_one](http://api.silverstripe.org/search/lookup/?q=DataObject::$has_one&version=2.4&module=mymodule)',
$result
);
}
ENHANCEMENT: Automatic (and manual) hash link generation for headlines done in server-side
2010-09-03 07:29:15 +02:00
function testHeadlineAnchors() {
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('test.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
$page->setLang('en');
$page->setVersion('2.4');
ENHANCEMENT: Automatic (and manual) hash link generation for headlines done in server-side
2010-09-03 07:29:15 +02:00
$result = DocumentationParser::rewrite_heading_anchors($page->getMarkdown(), $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);
}
ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
function testRelativeLinks() {
// Page on toplevel
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('test.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$result = DocumentationParser::rewrite_relative_links($page->getMarkdown(), $page, 'mycontroller/cms/2.4/en/');
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$this->assertContains(
'[link: subfolder index](mycontroller/cms/2.4/en/subfolder/)',
$result
);
$this->assertContains(
'[link: subfolder page](mycontroller/cms/2.4/en/subfolder/subpage)',
$result
);
$this->assertContains(
'[link: http](http://silverstripe.org)',
$result
);
$this->assertContains(
'[link: api](api:DataObject)',
$result
);
// Page in subfolder
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('subfolder/subpage.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$result = DocumentationParser::rewrite_relative_links($page->getMarkdown(), $page, 'mycontroller/cms/2.4/en/');
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$this->assertContains(
'[link: absolute index](mycontroller/cms/2.4/en/)',
$result
);
$this->assertContains(
'[link: absolute index with name](mycontroller/cms/2.4/en/index)',
$result
);
$this->assertContains(
'[link: relative index](mycontroller/cms/2.4/en/)',
$result
);
$this->assertContains(
'[link: relative parent page](mycontroller/cms/2.4/en/test)',
$result
);
$this->assertContains(
'[link: absolute parent page](mycontroller/cms/2.4/en/test)',
$result
);
// Page in nested subfolder
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
$page = new DocumentationPage();
$page->setRelativePath('subfolder/subsubfolder/subsubpage.md');
$page->setEntity(new DocumentationEntity('mymodule', '2.4', BASE_PATH . '/sapphiredocs/tests/docs/'));
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$result = DocumentationParser::rewrite_relative_links($page->getMarkdown(), $page, 'mycontroller/cms/2.4/en/');
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 22:27:23 +02:00
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information. ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0] MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 06:46:32 +02:00
$this->assertContains(
'[link: absolute index](mycontroller/cms/2.4/en/)',
$result
);
$this->assertContains(
'[link: relative index](mycontroller/cms/2.4/en/subfolder/)',
$result
);
$this->assertContains(
'[link: relative parent page](mycontroller/cms/2.4/en/subfolder/subpage)',
$result
);
$this->assertContains(
'[link: relative grandparent page](mycontroller/cms/2.4/en/test)',
$result
);
$this->assertContains(
'[link: absolute page](mycontroller/cms/2.4/en/test)',
$result
);
}
ENHANCEMENT Excluding _images folders automatically
2010-08-01 06:46:26 +02:00
}
Reference in New Issue Copy Permalink