tonyair
/
silverstripe-docsviewer
mirror of https://github.com/silverstripe/silverstripe-docsviewer
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #137 from creative-commoners/pulls/2.0/psr2 

Apply PSR-2 coding conventions
This commit is contained in:
Franco Springveldt 2017-09-07 15:38:53 +12:00 committed by GitHub
parent 42f57bc67e fe8b9a37b5
commit 7d22660989
19 changed files with 141 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
code/DocumentationHelper.php
View File

@ -8,7 +8,7 @@
class DocumentationHelper
{
/**
* String helper for cleaning a file name to a readable version.
* String helper for cleaning a file name to a readable version.
*
* @param string $name to convert
*
@ -95,9 +95,9 @@ class DocumentationHelper
/**
* Helper function to normalize paths to unix style directory separators
*
*
* @param string
*
*
* @return string
*/
public static function normalizePath($path)
@ -111,9 +111,9 @@ class DocumentationHelper
/**
* Helper function to make normalized paths relative
*
*
* @param string
*
*
* @return string
*/
public static function relativePath($path)

26
code/DocumentationManifest.php
View File

@ -90,7 +90,9 @@ class DocumentationManifest
$this->registeredEntities = new ArrayList();
$this->cache = SS_Cache::factory(
'DocumentationManifest', 'Core', array(
'DocumentationManifest',
'Core',
array(
'automatic_serialization' => true,
'lifetime' => null
)
@ -159,7 +161,8 @@ class DocumentationManifest
* @var DocumentationEntity $entity
*/
$entity = Injector::inst()->create(
'DocumentationEntity', $key
'DocumentationEntity',
$key
);
$entity->setPath(DocumentationHelper::normalizePath(Controller::join_links($path, $lang, '/')));
@ -242,7 +245,9 @@ class DocumentationManifest
}
Config::inst()->update(
'DocumentationManifest', 'register_entities', $entities
'DocumentationManifest',
'register_entities',
$entities
);
$this->automaticallyPopulated = true;
@ -371,7 +376,8 @@ class DocumentationManifest
foreach ($grouped as $entity) {
uasort(
$entity, function ($a, $b) {
$entity,
function ($a, $b) {
// ensure parent directories are first
$a['filepath'] = str_replace('index.md', '', $a['filepath']);
$b['filepath'] = str_replace('index.md', '', $b['filepath']);
@ -417,7 +423,8 @@ class DocumentationManifest
Config::inst()->get('DocumentationViewer', 'link_base'),
'',
$link
), '/'
),
'/'
);
}
@ -461,7 +468,10 @@ class DocumentationManifest
public function handleFolder($basename, $path, $depth)
{
$folder = Injector::inst()->create(
'DocumentationFolder', $this->entity, $basename, $path
'DocumentationFolder',
$this->entity,
$basename,
$path
);
// Add main folder link
@ -491,7 +501,9 @@ class DocumentationManifest
{
$page = Injector::inst()->create(
'DocumentationPage',
$this->entity, $basename, $path
$this->entity,
$basename,
$path
);
// populate any meta data

2
code/DocumentationManifestFileFinder.php
View File

@ -21,7 +21,7 @@ class DocumentationManifestFileFinder extends SS_FileFinder
);
/**
*
*
*/
public function acceptDir($basename, $pathname, $depth)
{

25
code/DocumentationParser.php
View File

@ -125,7 +125,6 @@ class DocumentationParser
$inner = true;
}
} elseif (preg_match('/^[\ ]{0,3}?[\t](.*)/', $line, $matches)) {
// inner line of block, or first line of standard markdown code block
// regex removes first tab (any following tabs are part of the code).
if (!$started) {
@ -248,7 +247,9 @@ class DocumentationParser
if (substr($url, 0, 1) == '/') {
$relativeUrl = DocumentationHelper::normalizePath(
str_replace(
BASE_PATH, '', Controller::join_links(
BASE_PATH,
'',
Controller::join_links(
$page->getEntity()->getPath(),
$url
)
@ -326,11 +327,11 @@ class DocumentationParser
$html_format = '<a href="http://api.silverstripe.org/search/lookup/?q=%s&version=%s&module=%s">%s</a>';
// parse api links without backticks into html
foreach($regexs as $type => $regex) {
foreach ($regexs as $type => $regex) {
preg_match_all($regex, $markdown, $links);
if($links) {
foreach($links[0] as $i => $match) {
if($type === 'no_title') {
if ($links) {
foreach ($links[0] as $i => $match) {
if ($type === 'no_title') {
$title = $links[1][$i];
$link = $links[1][$i];
// change backticked links to avoid being parsed in the same way as non-backticked links
@ -349,8 +350,8 @@ class DocumentationParser
// recover backticked links with no titles
preg_match_all('#XYZ(.*)?XYZ#', $markdown, $links);
if($links) {
foreach($links[0] as $i => $match) {
if ($links) {
foreach ($links[0] as $i => $match) {
$link = $links[1][$i];
$markdown = str_replace($match, '`[api:'.$link.']`', $markdown);
}
@ -358,8 +359,8 @@ class DocumentationParser
// recover backticked links with titles
preg_match_all('#XX(.*)?YY(.*)?ZZ#', $markdown, $links);
if($links) {
foreach($links[0] as $i => $match) {
if ($links) {
foreach ($links[0] as $i => $match) {
$title = $links[1][$i];
$link = $links[2][$i];
$markdown = str_replace($match, '`['.$title.'](api:'.$link.')`', $markdown);
@ -367,7 +368,6 @@ class DocumentationParser
}
return $markdown;
}
/**
@ -488,7 +488,7 @@ class DocumentationParser
$fileBaseLink,
$url
);
} else if (preg_match('/^#/', $url)) {
} elseif (preg_match('/^#/', $url)) {
// for relative links begining with a hash use the current page link
$relativeUrl = Controller::join_links($baselink, $page->getRelativeLink(), $url);
} else {
@ -521,5 +521,4 @@ class DocumentationParser
return $md;
}
}

4
code/DocumentationPermalinks.php
View File

@ -1,7 +1,7 @@
<?php
/**
* A mapping store of given permalinks to the full documentation path or useful
* A mapping store of given permalinks to the full documentation path or useful
* for customizing the shortcut URLs used in the viewer.
*
* Redirects the user from example.com/foo to example.com/en/module/foo
@ -25,7 +25,7 @@ class DocumentationPermalinks
* ));
* </code>
*
* Do not need to include the language or the version current as it
* Do not need to include the language or the version current as it
* will add it based off the language or version in the session
*
* @param array

17
code/DocumentationSearch.php
View File

@ -8,20 +8,20 @@ set_include_path(
require_once 'Zend/Search/Lucene.php';
/**
* Documentation Search powered by Lucene. You will need Zend_Lucene installed
* Documentation Search powered by Lucene. You will need Zend_Lucene installed
* on your path.
*
* To rebuild the indexes run the {@link RebuildLuceneDocsIndex} task. You may
* To rebuild the indexes run the {@link RebuildLuceneDocsIndex} task. You may
* wish to setup a cron job to remake the indexes on a regular basis.
*
* This class has the ability to generate an OpenSearch RSS formatted feeds
* This class has the ability to generate an OpenSearch RSS formatted feeds
* simply by using the URL:
*
* <code>
* yoursite.com/search/?q=Foo&format=rss. // Format can either be specified as rss or left off.
* </code>
*
* To get a specific amount of results you can also use the modifiers start and
* To get a specific amount of results you can also use the modifiers start and
* limit:
*
* <code>
@ -127,7 +127,7 @@ class DocumentationSearch
* Folder name for indexes (in the temp folder).
*
* @config
* @var string
* @var string
*/
private static $index_location;
@ -363,7 +363,7 @@ class DocumentationSearch
}
/**
* OpenSearch MetaData fields. For a list of fields consult
* OpenSearch MetaData fields. For a list of fields consult
* {@link self::get_meta_data()}
*
* @param array
@ -406,7 +406,7 @@ class DocumentationSearch
}
/**
* Renders the search results into a template. Either the search results
* Renders the search results into a template. Either the search results
* template or the Atom feed.
*/
public function renderResults()
@ -428,7 +428,8 @@ class DocumentationSearch
$title = ($title = $this->getTitle()) ? ' - '. $title : "";
$link = Controller::join_links(
$this->outputController->Link(), 'DocumentationOpenSearchController/description/'
$this->outputController->Link(),
'DocumentationOpenSearchController/description/'
);
$data->setField('Title', $data->Title . $title);

17
code/controllers/DocumentationViewer.php
View File

@ -110,7 +110,7 @@ class DocumentationViewer extends Controller implements PermissionProvider
)
);
Requirements::combine_files(
'docs.css',
'docs.css',
array(
DOCSVIEWER_DIR .'/css/highlight.css',
DOCSVIEWER_DIR .'/css/normalize.css',
@ -204,7 +204,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
// Strip off the base url
//
$base = ltrim(
Config::inst()->get('DocumentationViewer', 'link_base'), '/'
Config::inst()->get('DocumentationViewer', 'link_base'),
'/'
);
if ($base && strpos($url, $base) !== false) {
@ -393,7 +394,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
// add children
$children = $this->getManifest()->getChildrenFor(
$entity->getPath(), ($record) ? $record->getPath() : $entity->getPath()
$entity->getPath(),
($record) ? $record->getPath() : $entity->getPath()
);
} else {
if ($current && $current->getKey() == $entity->getKey()) {
@ -438,7 +440,7 @@ class DocumentationViewer extends Controller implements PermissionProvider
public function replaceChildrenCalls($html)
{
$codes = new ShortcodeParser();
$codes->register('CHILDREN', array($this, 'includeChildren'));
$codes->register('CHILDREN', array($this, 'includeChildren'));
return $codes->parse($html);
}
@ -694,7 +696,6 @@ class DocumentationViewer extends Controller implements PermissionProvider
$entity = $page->getEntity();
if ($entity && isset(self::$edit_links[strtolower($entity->title)])) {
// build the edit link, using the version defined
$url = self::$edit_links[strtolower($entity->title)];
$version = $entity->getVersion();
@ -738,7 +739,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
{
return ($this->record)
? $this->getManifest()->getNextPage(
$this->record->getPath(), $this->getEntity()->getPath()
$this->record->getPath(),
$this->getEntity()->getPath()
)
: null;
}
@ -753,7 +755,8 @@ class DocumentationViewer extends Controller implements PermissionProvider
{
return ($this->record)
? $this->getManifest()->getPreviousPage(
$this->record->getPath(), $this->getEntity()->getPath()
$this->record->getPath(),
$this->getEntity()->getPath()
)
: null;
}

3
code/forms/DocumentationAdvancedSearchForm.php
View File

@ -34,7 +34,8 @@ class DocumentationAdvancedSearchForm extends Form
CheckboxSetField::create(
'Versions',
_t('DocumentationViewer.VERSIONS', 'Versions'),
$versions, $searchedVersions
$versions,
$searchedVersions
)
);

4
code/models/DocumentationFolder.php
View File

@ -1,9 +1,9 @@
<?php
/**
* A specific documentation folder within a {@link DocumentationEntity}.
* A specific documentation folder within a {@link DocumentationEntity}.
*
* Maps to a folder on the file system.
* Maps to a folder on the file system.
*
* @package docsviewer
* @subpackage model

3
code/models/DocumentationPage.php
View File

@ -87,7 +87,8 @@ class DocumentationPage extends ViewableData
);
$titleParts = array_filter(
$titleParts, function ($val) {
$titleParts,
function ($val) {
if ($val) {
return $val;
}

12
code/tasks/CheckDocsSourcesTask.php
View File

@ -10,16 +10,16 @@ class CheckDocsSourcesTask extends BuildTask
protected $description = "Check validity of all docs source files registered";
public function start()
public function start()
{
if(!Director::is_cli()) {
if (!Director::is_cli()) {
echo "<ul>";
}
}
public function end()
public function end()
{
if(Director::is_cli()) {
if (Director::is_cli()) {
echo "\nTotal errors: {$this->errors}\n";
} else {
echo "</ul>";
@ -27,10 +27,10 @@ class CheckDocsSourcesTask extends BuildTask
}
}
public function showError($error)
public function showError($error)
{
$this->errors++;
if(Director::is_cli()) {
if (Director::is_cli()) {
echo "\n$error";
} else {
echo "<li>" . Convert::raw2xml($error) . "</li>";

16
code/tasks/RebuildLuceneDocsIndex.php
View File

@ -1,9 +1,9 @@
<?php
/**
* Rebuilds the search indexes for the documentation pages.
* Rebuilds the search indexes for the documentation pages.
*
* For the hourly cron rebuild use RebuildLuceneDocusIndex_Hourly
* For the hourly cron rebuild use RebuildLuceneDocusIndex_Hourly
*
* @package docsviewer
* @subpackage tasks
@ -87,25 +87,29 @@ class RebuildLuceneDocsIndex extends BuildTask
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
'Version', $page->getEntity()->getVersion()
'Version',
$page->getEntity()->getVersion()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
'Language', $page->getEntity()->getLanguage()
'Language',
$page->getEntity()->getLanguage()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
'Entity', $page->getEntity()
'Entity',
$page->getEntity()
)
);
$doc->addField(
Zend_Search_Lucene_Field::Keyword(
'Link', $page->Link()
'Link',
$page->Link()
)
);

4
tests/DocumentationEntityTest.php
View File

@ -2,7 +2,7 @@
class DocumentationEntityTest extends SapphireTest
{
public function dataCompare()
public function dataCompare()
{
return array(
array('3', '3.0', 1),
@ -20,7 +20,7 @@ class DocumentationEntityTest extends SapphireTest
* @param string $right
* @param int $result
*/
public function testCompare($left, $right, $result)
public function testCompare($left, $right, $result)
{
$leftVersion = new DocumentationEntity('Framework');
$leftVersion->setVersion($left);

15
tests/DocumentationManifestTests.php
View File

@ -16,18 +16,24 @@ class DocumentationManifestTests extends SapphireTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs'
'DocumentationViewer',
'link_base',
'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
'DocumentationManifest', 'automatic_registration', false
'DocumentationManifest',
'automatic_registration',
false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
'DocumentationManifest', 'register_entities', array(
'DocumentationManifest',
'register_entities',
array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',
@ -189,7 +195,8 @@ class DocumentationManifestTests extends SapphireTest
);
$this->assertDOSContains(
$expected, $this->manifest->getChildrenFor(
$expected,
$this->manifest->getChildrenFor(
DOCSVIEWER_PATH . '/tests/docs/en/'
)
);

3
tests/DocumentationPageTest.php
View File

@ -42,7 +42,8 @@ class DocumentationPageTest extends SapphireTest
// single layer
$this->assertEquals(
'dev/docs/en/doctest/2.4/test/', $page->Link(),
'dev/docs/en/doctest/2.4/test/',
$page->Link(),
'The page link should have no extension and have a language'
);

22
tests/DocumentationParserTest.php
View File

@ -23,7 +23,9 @@ class DocumentationParserTest extends SapphireTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs/'
'DocumentationViewer',
'link_base',
'dev/docs/'
);
$this->entity = new DocumentationEntity('DocumentationParserTest');
@ -294,7 +296,9 @@ HTML;
);
$expected = Controller::join_links(
Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/subfolder/_images/image.png'
Director::absoluteBaseURL(),
DOCSVIEWER_DIR,
'/tests/docs/en/subfolder/_images/image.png'
);
$this->assertContains(
@ -304,15 +308,20 @@ HTML;
$this->assertContains(
sprintf(
'[parent image link](%s)', Controller::join_links(
Director::absoluteBaseURL(), DOCSVIEWER_DIR, '/tests/docs/en/_images/image.png'
'[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'
Director::absoluteBaseURL(),
DOCSVIEWER_DIR,
'/tests/docs/en/_images/image.png'
);
$this->assertContains(
@ -350,11 +359,10 @@ HTML;
array('[Title](api:DataObject::populateDefaults())',sprintf($html_format, 'DataObject::populateDefaults()', 'Title'))
);
foreach($test_cases as $test_case) {
foreach ($test_cases as $test_case) {
$expected_html = $test_case[1];
$this->assertContains($expected_html, $parsed_page);
}
}
public function testHeadlineAnchors()

18
tests/DocumentationSearchTest.php
View File

@ -13,20 +13,26 @@ class DocumentationSearchTest extends FunctionalTest
Config::nest();
// explicitly use dev/docs. Custom paths should be tested separately
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs'
'DocumentationViewer',
'link_base',
'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
'DocumentationManifest', 'automatic_registration', false
'DocumentationManifest',
'automatic_registration',
false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update('DocumentationSearch', 'enabled', true);
Config::inst()->update(
'DocumentationManifest', 'register_entities', array(
'DocumentationManifest',
'register_entities',
array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs-search/",
'Title' => 'Docs Search Test', )
@ -54,8 +60,8 @@ class DocumentationSearchTest extends FunctionalTest
$response = $c->handleRequest(new SS_HTTPRequest('GET', 'description/'), DataModel::inst());
// $this->assertEquals(404, $response->getStatusCode());
// test we get a response to the description. The meta data test will
// check that the individual fields are valid but we should check urls
// test we get a response to the description. The meta data test will
// check that the individual fields are valid but we should check urls
// are there
Config::inst()->update('DocumentationSearch', 'enabled', true);

12
tests/DocumentationViewerTest.php
View File

@ -22,18 +22,24 @@ class DocumentationViewerTest extends FunctionalTest
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs/'
'DocumentationViewer',
'link_base',
'dev/docs/'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
'DocumentationManifest', 'automatic_registration', false
'DocumentationManifest',
'automatic_registration',
false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
'DocumentationManifest', 'register_entities', array(
'DocumentationManifest',
'register_entities',
array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',

14
tests/DocumentationViewerVersionWarningTest.php
View File

@ -16,20 +16,26 @@ class DocumentationViewerVersionWarningTest extends SapphireTest
Config::nest();
// explicitly use dev/docs. Custom paths should be tested separately
// explicitly use dev/docs. Custom paths should be tested separately
Config::inst()->update(
'DocumentationViewer', 'link_base', 'dev/docs'
'DocumentationViewer',
'link_base',
'dev/docs'
);
// disable automatic module registration so modules don't interfere.
Config::inst()->update(
'DocumentationManifest', 'automatic_registration', false
'DocumentationManifest',
'automatic_registration',
false
);
Config::inst()->remove('DocumentationManifest', 'register_entities');
Config::inst()->update(
'DocumentationManifest', 'register_entities', array(
'DocumentationManifest',
'register_entities',
array(
array(
'Path' => DOCSVIEWER_PATH . "/tests/docs/",
'Title' => 'Doc Test',