[RFR] Doc generator

composer.json

@@ -18,7 +18,8 @@
         "alecsammon/php-raml-parser": "~2.0",
         "doctrine/dbal": "~2.4",
         "pagerfanta/pagerfanta": "~1.0",
-        "phpunit/dbunit": "~1.3"
+        "phpunit/dbunit": "~1.3",
+        "twig/twig": "~1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.2.0",

examples/stack/composer.json

@@ -9,10 +9,17 @@
     "require": {
         "stack/builder": "^1.0",
         "stack/run": "^1.0",
+        "stack/url-map": "1.2.x-dev",
         "marmelab/microrest": "dev-stackphp",
-        "asm89/stack-cors": "dev-master"
+        "asm89/stack-cors": "dev-master",
+        "twig/twig": "~1.0"
     },
     "scripts": {
+        "post-install-cmd": [
+            "cd css && ln -s ../vendor/marmelab/microrest/web/css microrest",
+            "cd js && ln -s ../vendor/marmelab/microrest/web/js microrest",
+            "cp app.db.dist app.db"
+        ],
         "run": [
             "echo 'Started web server on http://localhost:8888'",
             "php -S localhost:8888"

examples/stack/index.php

@@ -4,6 +4,7 @@
 use Asm89\Stack\Cors;
 use Marmelab\Microrest\Stack\RamlConfig\RamlConfig;
 use Marmelab\Microrest\Stack\RouteGenerator\RouteGenerator;
+use Marmelab\Microrest\Stack\DocGenerator\DocGenerator;
 use Marmelab\Microrest\RouteBuilder;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -16,13 +17,14 @@ public function handle(Symfony\Component\HttpFoundation\Request $request, $type
     }
 }
 
+$mainApp = new MainApp();
 $stack = (new Stack\Builder())
     ->push(Cors::class, [
-        'allowedHeaders' => ['x-total-count'],
-        'allowedMethods' => RouteBuilder::$validMethods,
-        'allowedOrigins' => ['*'],
-        'exposedHeaders' => true,
-    ])
+            'allowedHeaders' => ['x-total-count'],
+            'allowedMethods' => RouteBuilder::$validMethods,
+            'allowedOrigins' => ['*'],
+            'exposedHeaders' => true,
+            ])
     ->push(RamlConfig::class, [
         'path' => __DIR__.'/api.raml',
     ])
@@ -31,8 +33,11 @@ public function handle(Symfony\Component\HttpFoundation\Request $request, $type
             'driver' => 'pdo_sqlite',
             'path' => __DIR__.'/app.db',
         ],
+    ])
+    ->push('Stack\UrlMap', [
+        "/doc" => new DocGenerator($mainApp)
     ]);
 
-$app = $stack->resolve(new MainApp());
+$app = $stack->resolve($mainApp);
 
 Stack\run($app);

makefile

@@ -4,12 +4,14 @@ install-demo:
 	composer -d=examples/ng-admin install
 	bower --config.cwd=./examples/ng-admin/web/admin install
 	cp examples/ng-admin/app.db-dist examples/ng-admin/app.db
+	composer -d=examples/stack install
+	cp examples/ng-admin/app.db-dist examples/stack/app.db
 
 demo-ng-admin:
 	composer -d=examples/ng-admin run
 
 demo-stack:
-    composer -d=examples/stack run
+	composer -d=examples/stack run
 
 install:
 	composer install --dev --prefer-source

src/Stack/DocGenerator/DocGenerator.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Marmelab\Microrest\Stack\DocGenerator;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+
+class DocGenerator implements HttpKernelInterface
+{
+    private $app;
+    private $definition;
+
+    public function __construct(HttpKernelInterface $app, array $options = [])
+    {
+        $this->app = $app;
+    }
+
+    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
+    {
+        $this->definition = $request->attributes->get('raml.config');
+        $response = $this->app->handle($request, $type, $catch);
+        // Render twig views/doc.html.twig, genereted with webpack from src, with definition as parameter
+
+        $loader = new \Twig_Loader_Filesystem(__DIR__ . '/views');
+        $twig = new \Twig_Environment($loader);
+        $description = $this->getFormatedDescription();
+        $html = $twig->render('doc.html.twig', $description);
+        $response = new Response($html);
+        return $response;
+    }
+
+    private function getFormatedDescription ()
+    {
+        $resources = array();
+        foreach ($this->definition->getResources() as $resource) {
+            $endpoints = array();
+            foreach ($resource->getMethods() as $method) {
+                $endpoints[] = [
+                    'uri' => $resource->getUri(),
+                    'method' => $method->getType(),
+                    'description' => $method->getDescription(),
+                ];
+            }
+
+            foreach ($resource->getResources() as $endpoint) {
+                foreach ($endpoint->getMethods() as $method) {
+                    $endpoints[] = [
+                        'uri' => $endpoint->getUri(),
+                        'method' => $method->getType(),
+                        'description' => $method->getDescription(),
+                    ];
+                }
+            }
+
+            $resources[] = [
+                'uri' => $resource->getUri(),
+                'name' => $resource->getDisplayName(),
+                'description' => $resource->getDescription(),
+                'endpoints' => $endpoints,
+            ];
+        }
+
+        return array(
+            'apiName' => $this->definition->getTitle(),
+            'resources' => $resources,
+            'baseUrl' => $this->definition->getBaseUrl(),
+            'version' => $this->definition->getVersion(),
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function terminate(Request $request, Response $response)
+    {
+        $this->kernel->terminate($request, $response);
+    }
+}