RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Fix 8c9b8331d066269d48ca374280937be264767ee6

Browse Source 
* tests
* CS
This commit is contained in:
William DURAND 2013-03-17 16:40:31 +01:00
parent 8c9b8331d0
commit 2fd3f33ad8
5 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Annotation/ApiDoc.php
View File

@ -366,7 +366,7 @@ class ApiDoc
$data['statusCodes'] = $statusCodes; $data['statusCodes'] = $statusCodes;
} }
if($section = $this->section) { if ($section = $this->section) {
$data['section'] = $section; $data['section'] = $section;
} }

5
Formatter/AbstractFormatter.php
View File

@ -134,7 +134,7 @@ abstract class AbstractFormatter implements FormatterInterface
foreach ($array as $section => $resources) { foreach ($array as $section => $resources) {
foreach ($resources as $path => $annotations) { foreach ($resources as $path => $annotations) {
foreach ($annotations as $annotation) { foreach ($annotations as $annotation) {
if($section) { if ($section) {
$processedCollection[$section][$path][] = $this->processAnnotation($annotation); $processedCollection[$section][$path][] = $this->processAnnotation($annotation);
} else { } else {
$processedCollection['_others'][$path][] = $this->processAnnotation($annotation); $processedCollection['_others'][$path][] = $this->processAnnotation($annotation);
@ -143,7 +143,8 @@ abstract class AbstractFormatter implements FormatterInterface
} }
} }
ksort($processedCollection); ksort($processedCollection);
return $processedCollection; return $processedCollection;
} }
} }

24
Formatter/MarkdownFormatter.php
View File

@ -111,21 +111,31 @@ class MarkdownFormatter extends AbstractFormatter
protected function render(array $collection) protected function render(array $collection)
{ {
$markdown = ''; $markdown = '';
foreach ($collection as $resource => $arrayOfData) { foreach ($collection as $section => $resources) {
$markdown .= $this->renderResourceSection($resource, $arrayOfData); $markdown .= $this->renderResourceSection($section, $resources);
$markdown .= "\n"; $markdown .= "\n";
} }
return trim($markdown); return trim($markdown);
} }
private function renderResourceSection($resource, array $arrayOfData) private function renderResourceSection($section, array $resources)
{ {
$markdown = sprintf("# %s #\n\n", $resource); if ('_others' !== $section) {
$markdown = sprintf("# %s #\n\n", $section);
}
foreach ($arrayOfData as $data) { foreach ($resources as $resource => $methods) {
$markdown .= $this->renderOne($data); if ('_others' === $section && 'others' !== $resource) {
$markdown .= "\n"; $markdown = sprintf("## %s ##\n\n", $resource);
} elseif ('others' !== $resource) {
$markdown = sprintf("## %s ##\n\n", $resource);
}
foreach ($methods as $method) {
$markdown .= $this->renderOne($method);
$markdown .= "\n";
}
} }
return $markdown; return $markdown;

2
Resources/views/resources.html.twig
View File

@ -29,6 +29,6 @@
{% endfor %} {% endfor %}
{% if section != '_others' %} {% if section != '_others' %}
</div> </div>
{% endif %} {% endif %}
{% endfor %} {% endfor %}
{% endblock content %} {% endblock content %}

5
Tests/Formatter/MarkdownFormatterTest.php
View File

@ -26,7 +26,7 @@ class MarkdownFormatterTest extends WebTestCase
$result = $container->get('nelmio_api_doc.formatter.markdown_formatter')->format($data); $result = $container->get('nelmio_api_doc.formatter.markdown_formatter')->format($data);
$expected = <<<MARKDOWN $expected = <<<MARKDOWN
# /tests # ## /tests ##
### `GET` /tests.{_format} ### ### `GET` /tests.{_format} ###
@ -126,9 +126,6 @@ c:
* required: true * required: true
# others #
### `POST` /another-post ### ### `POST` /another-post ###
_create another test_ _create another test_