Add template engine kit and fix source code urls questions

steevanb · phpbenchmarks · commit 510c990786dc · 2019-05-01T22:23:43.000+02:00
diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ Choose the component type and benchmark type you want to code:
   * [Hello world benchmark](documentation/framework/helloWorld.md)
   * [REST API benchmark](documentation/framework/restApi.md)
 * Template engine
-  * Hello world benchmark (coming soon)
+  * [Hello world benchmark](documentation/templateEngine/helloWorld.md)
 
 Note that `all` component benchmarks needs to bo validated to make your component appear on [phpbenchmarks.com](http://www.phpbenchmarks.com).
 
diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,8 @@
+### [3.1.0](../../compare/3.0.2...3.1.0) - 2018-05-01
+
+- Add template engine kit
+- Fix source code urls questions
+
 ### [3.0.2](../../compare/3.0.1...3.0.2) - 2018-04-28
 
 - Change `responseBodyFileMinSize` for REST API for serializer who not escape `/`.
diff --git a/documentation/framework/helloWorld.md b/documentation/framework/helloWorld.md
@@ -1,9 +1,9 @@
 Hello world benchmark
 -
 
-This benchmark shows the overhead cost of using a framework, instead of writing your code in PHP.
+This benchmark shows the overhead cost of using a framework instead of writing your code in PHP.
 
-To respect that, code should write `Hello World !` (yes, with space before `!`, cocorico ;)) in response body, as fast as possible.
+To respect that code should write `Hello World !` (yes, with space before `!`, cocorico ;)) in response body, as fast as possible.
 
 Disable everything you can: template engine, session, database access etc.
 
@@ -12,8 +12,8 @@ Features
 
 Don't forget this features as to be coded in [common repository](../repositoriesAndBranches.md).
 
-* A route, with the url `benchmark/helloworld`. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_hello-world/Resources/config/routing.yml).
-* A controller, called by this route. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_hello-world/Controller/HelloWorldController.php).
+* A route with the url `benchmark/helloworld`. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_hello-world/Resources/config/routing.yml).
+* A controller called by this route. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_hello-world/Controller/HelloWorldController.php).
 * This controller should write `Hello World !` in response body as fast as possible. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_hello-world/Controller/HelloWorldController.php#L13).
 
 [Back to documentation index](../../README.md)
diff --git a/documentation/templateEngine/helloWorld.md b/documentation/templateEngine/helloWorld.md
@@ -0,0 +1,17 @@
+Hello world benchmark
+-
+
+This benchmark shows the overhead cost of using a template engine instead of writing your code in PHP.
+
+To respect that code should write `Hello World !` (yes, with space before `!`, cocorico ;)) in response body, as fast as possible.
+
+Features
+-
+
+Don't forget this features as to be coded in [common repository](../repositoriesAndBranches.md).
+
+* An entry point. [Example](https://github.com/phpbenchmarks/twig-common/blob/2.1.0/helloworld.php).
+* A template used by this entry point. [Example](https://github.com/phpbenchmarks/twig-common/blob/2.1.0/templates/helloworld.html.twig).
+* Write `Hello World !` in response body as fast as possible. [Example](https://github.com/phpbenchmarks/twig-common/blob/2.1.0/helloworld.php#L8).
+
+[Back to documentation index](../../README.md)
diff --git a/src/Benchmark/BenchmarkType.php b/src/Benchmark/BenchmarkType.php
@@ -21,7 +21,11 @@ class BenchmarkType
             'defaultBenchmarkUrl' => '/benchmark/helloworld',
             'responseBodyFiles' => ['responseBody.txt'],
             'responseBodyFileMinSize' => 13,
-            'sourceCodeUrlIds' => ['route', 'controller']
+            'sourceCodeUrlIds' => [
+                ComponentType::PHP => ['entryPoint'],
+                ComponentType::FRAMEWORK => ['route', 'controller'],
+                ComponentType::TEMPLATE_ENGINE => ['entryPoint', 'template']
+            ]
         ],
         self::REST_API => [
             'name' => 'REST API',
@@ -31,13 +35,23 @@ class BenchmarkType
             'responseBodyFiles' => ['responseBody.en_GB.json', 'responseBody.fr_FR.json', 'responseBody.en.json'],
             'responseBodyFileMinSize' => 7541,
             'sourceCodeUrlIds' => [
-                'route',
-                'controller',
-                'randomizeLanguageDispatchEvent',
-                'randomizeLanguageEventListener',
-                'translations',
-                'translate',
-                'serialize'
+                ComponentType::PHP => [
+                    'entryPoint',
+                    'randomizeLanguageDispatchEvent',
+                    'randomizeLanguageEventListener',
+                    'translations',
+                    'translate',
+                    'serialize'
+                ],
+                ComponentType::FRAMEWORK => [
+                    'route',
+                    'controller',
+                    'randomizeLanguageDispatchEvent',
+                    'randomizeLanguageEventListener',
+                    'translations',
+                    'translate',
+                    'serialize'
+                ]
             ]
         ],
         self::TEMPLATING_SMALL_OVERLOAD => [
@@ -46,15 +60,19 @@ class BenchmarkType
             'slug' => 'templating-small-overload',
             'defaultBenchmarkUrl' => '/index.php',
             'responseBodyFiles' => ['responseBody.html'],
-            'sourceCodeUrlIds' => []
+            'sourceCodeUrlIds' => [
+                ComponentType::PHP => ['entryPoint']
+            ]
         ],
         self::TEMPLATING_BIG_OVERLOAD => [
             'name' => 'Template engine big overload',
             'upperCamelCaseName' => 'TemplateEngineBigOverload',
             'slug' => 'templating-big-overload',
             'defaultBenchmarkUrl' => '/index.php',
             'responseBodyFiles' => ['responseBody.html'],
-            'sourceCodeUrlIds' => []
+            'sourceCodeUrlIds' => [
+                ComponentType::PHP => ['entryPoint']
+            ]
         ]
     ];
 
@@ -75,6 +93,7 @@ public static function getAllByComponentType(): array
         return [
             ComponentType::PHP => [
                 static::HELLO_WORLD => $benchmarkTypes[static::HELLO_WORLD],
+                static::REST_API => $benchmarkTypes[static::REST_API],
                 static::TEMPLATING_SMALL_OVERLOAD => $benchmarkTypes[static::TEMPLATING_SMALL_OVERLOAD],
                 static::TEMPLATING_BIG_OVERLOAD => $benchmarkTypes[static::TEMPLATING_BIG_OVERLOAD]
             ],
@@ -123,9 +142,9 @@ public static function getResponseBodyFileMinSize(int $type): int
         return static::getConfiguration($type, 'responseBodyFileMinSize');
     }
 
-    public static function getSourceCodeUrlIds(int $type): array
+    public static function getSourceCodeUrlIds(int $type, int $componentType): array
     {
-        return static::getConfiguration($type, 'sourceCodeUrlIds');
+        return static::getConfiguration($type, 'sourceCodeUrlIds')[$componentType];
     }
 
     /** @return mixed */
diff --git a/src/Command/Configure/ConfigureComponentCommand.php b/src/Command/Configure/ConfigureComponentCommand.php
@@ -176,7 +176,7 @@ protected function createFile(): int
             $componentTypes
         );
 
-        $benchmarkTypes = BenchmarkType::getAll();
+        $benchmarkTypes = BenchmarkType::getByComponentType($componentType);
         $benchmarkType = array_search(
             $this->choiceQuestion('Benchmark type?', $benchmarkTypes),
             $benchmarkTypes
diff --git a/src/Command/Configure/ConfigureComponentSourceCodeUrlsCommand.php b/src/Command/Configure/ConfigureComponentSourceCodeUrlsCommand.php
@@ -6,6 +6,7 @@
 
 use AbstractComponentConfiguration\AbstractComponentConfiguration;
 use App\{
+    Benchmark\BenchmarkType,
     Command\AbstractCommand,
     Command\Validate\ValidateConfigurationComponentSourceCodeUrlsCommand,
     ComponentConfiguration\ComponentConfiguration
@@ -76,68 +77,88 @@ function () use ($url) {
 
     protected function getSourceCodeUrls(): array
     {
-        $urls = ComponentConfiguration::getSourceCodeUrls();
-        $return = [
+        $return = $this->getSourceCodeUrlsToAsk(
+            ComponentConfiguration::getBenchmarkType(),
+            ComponentConfiguration::getComponentType(),
+            ComponentConfiguration::getSourceCodeUrls()
+        );
+
+        foreach ($return as &$url) {
+            $violations = ValidateConfigurationComponentSourceCodeUrlsCommand::validateSourCodeUrl($url['url']);
+            $showWarning = false;
+            do {
+                if (count($violations) > 0 && $showWarning) {
+                    $errors = [];
+                    /** @var ConstraintViolationInterface $violation */
+                    foreach ($violations as $violation) {
+                        $errors[] = $violation->getMessage();
+                    }
+                    $this->warning(implode(', ', $errors));
+                }
+
+                $url['url'] = $this->question(
+                    $url['question'],
+                    substr($url['url'] ?? '', 0, 4) === '____' ? null : $url['url']
+                );
+
+                $showWarning = true;
+            } while (
+                count(
+                    $violations = ValidateConfigurationComponentSourceCodeUrlsCommand::validateSourCodeUrl($url['url'])
+                ) > 0
+            );
+        }
+
+        return $return;
+    }
+
+    protected function getSourceCodeUrlsToAsk(int $benchmarkType, int $componentType, array $defaultUrls): array
+    {
+        $availableUrls = [
+            'entryPoint' => [
+                'question' => 'URL to entry point code?',
+                'variable' => '____PHPBENCHMARKS_ENTRY_POINT_URL____'
+            ],
+            'template' => [
+                'question' => 'URL to template code?',
+                'variable' => '____PHPBENCHMARKS_TEMPLATE_URL____'
+            ],
             'route' => [
                 'question' => 'URL to benchmark route code?',
-                'url' => $urls['route'] ?? null,
                 'variable' => '____PHPBENCHMARKS_ROUTE_SOURCE_CODE_URL____'
             ],
             'controller' => [
                 'question' => 'URL to Controller code?',
-                'url' => $urls['controller'] ?? null,
                 'variable' => '____PHPBENCHMARKS_CONTROLLER_SOURCE_CODE_URL____'
             ],
             'randomizeLanguageDispatchEvent' => [
                 'question' => 'URL to code who dispatch event to randomize language?',
-                'url' => $urls['randomizeLanguageDispatchEvent'] ?? null,
                 'variable' => '____PHPBENCHMARKS_RANDOMIZE_LANGUAGE_DISPATCH_EVENT_SOURCE_CODE_URL____'
             ],
             'randomizeLanguageEventListener' => [
                 'question' => 'URL to code who listen event to randomize language?',
-                'url' => $urls['randomizeLanguageEventListener'] ?? null,
                 'variable' => '____PHPBENCHMARKS_RANDOMIZE_LANGUAGE_EVENT_LISTENER_SOURCE_CODE_URL____'
             ],
             'translations' => [
                 'question' => 'URL to en_GB translations code?',
-                'url' => $urls['translations'] ?? null,
                 'variable' => '____PHPBENCHMARKS_TRANSLATIONS_SOURCE_CODE_URL____'
             ],
             'translate' => [
                 'question' => 'URL to code who translate translated.1000 key?',
-                'url' => $urls['translate'] ?? null,
                 'variable' => '____PHPBENCHMARKS_TRANSLATE_SOURCE_CODE_URL____'
             ],
             'serialize' => [
                 'question' => 'URL to code who serialize User?',
-                'url' => $urls['serialize'] ?? null,
                 'variable' => '____PHPBENCHMARKS_SERIALIZE_SOURCE_CODE_URL____'
             ]
         ];
 
-        foreach ($return as &$url) {
-            $violations = ValidateConfigurationComponentSourceCodeUrlsCommand::validateSourCodeUrl($url['url']);
-            $showWarning = false;
-            do {
-                if (count($violations) > 0) {
-                    if ($showWarning) {
-                        $errors = [];
-                        /** @var ConstraintViolationInterface $violation */
-                        foreach ($violations as $violation) {
-                            $errors[] = $violation->getMessage();
-                        }
-                        $this->warning(implode(', ', $errors));
-                    }
-
-                    $url['url'] = $this->question($url['question']);
-                }
-
-                $showWarning = true;
-            } while (
-                count(
-                    $violations = ValidateConfigurationComponentSourceCodeUrlsCommand::validateSourCodeUrl($url['url'])
-                ) > 0
-            );
+        $return = [];
+        foreach (BenchmarkType::getSourceCodeUrlIds($benchmarkType, $componentType) as $urlId) {
+            if (array_key_exists($urlId, $availableUrls) === false) {
+                throw new \Exception('Unknown url id "' . $urlId . '".');
+            }
+            $return[$urlId] = array_merge($availableUrls[$urlId], ['url' => $defaultUrls[$urlId] ?? null]);
         }
 
         return $return;
diff --git a/src/Command/Validate/ValidateConfigurationComponentSourceCodeUrlsCommand.php b/src/Command/Validate/ValidateConfigurationComponentSourceCodeUrlsCommand.php
@@ -67,11 +67,14 @@ protected function assertCodeSourceUrls(): self
                 . ' parameter to validate it.'
             );
         } else {
-            $expectedUrlIds = BenchmarkType::getSourceCodeUrlIds(ComponentConfiguration::getBenchmarkType());
+            $expectedUrlIds = BenchmarkType::getSourceCodeUrlIds(
+                ComponentConfiguration::getBenchmarkType(),
+                ComponentConfiguration::getComponentType()
+            );
             $urls = ComponentConfiguration::getSourceCodeUrls();
             foreach ($urls as $id => $url) {
                 if (in_array($id, $expectedUrlIds) === false) {
-                    $this->error('getSourceCodeUrls() return an array with unknown key ' . $id . '.');
+                    $this->error('getSourceCodeUrls() return an array with unknown key "' . $id . '".');
                 }
 
                 $violations = static::validateSourCodeUrl($url);
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/AbstractComponentConfiguration.php b/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/AbstractComponentConfiguration.php
@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ____NAMESPACE____;
+
+abstract class AbstractComponentConfiguration
+{
+    public static function getComponentType(): int
+    {
+        return 3;
+    }
+
+    public static function getComponentName(): string
+    {
+        return '____PHPBENCHMARKS_COMPONENT_NAME____';
+    }
+
+    public static function getComponentSlug(): string
+    {
+        return '____PHPBENCHMARKS_COMPONENT_SLUG____';
+    }
+
+    public static function isPhp56Enabled(): bool
+    {
+        return ____PHPBENCHMARKS_PHP56_ENABLED____;
+    }
+
+    public static function isPhp70Enabled(): bool
+    {
+        return ____PHPBENCHMARKS_PHP70_ENABLED____;
+    }
+
+    public static function isPhp71Enabled(): bool
+    {
+        return ____PHPBENCHMARKS_PHP71_ENABLED____;
+    }
+
+    public static function isPhp72Enabled(): bool
+    {
+        return ____PHPBENCHMARKS_PHP72_ENABLED____;
+    }
+
+    public static function isPhp73Enabled(): bool
+    {
+        return ____PHPBENCHMARKS_PHP73_ENABLED____;
+    }
+
+    public static function getBenchmarkUrl(): string
+    {
+        return '____PHPBENCHMARKS_BENCHMARK_URL____';
+    }
+
+    public static function getCoreDependencyName(): string
+    {
+        return '____PHPBENCHMARKS_CORE_DEPENDENCY_NAME____';
+    }
+
+    public static function getCoreDependencyMajorVersion(): int
+    {
+        return ____PHPBENCHMARKS_CORE_DEPENDENCY_MAJOR_VERSION____;
+    }
+
+    public static function getCoreDependencyMinorVersion(): int
+    {
+        return ____PHPBENCHMARKS_CORE_DEPENDENCY_MINOR_VERSION____;
+    }
+
+    public static function getCoreDependencyPatchVersion(): int
+    {
+        return ____PHPBENCHMARKS_CORE_DEPENDENCY_PATCH_VERSION____;
+    }
+
+    public static function getBenchmarkType(): int
+    {
+        return 1;
+    }
+
+    public static function getSourceCodeUrls(): array
+    {
+        return [
+            'entryPoint' => '____PHPBENCHMARKS_ENTRY_POINT_URL____',
+            'template' => '____PHPBENCHMARKS_TEMPLATE_URL____'
+        ];
+    }
+}
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/getSourceCodeUrls.tpl b/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/getSourceCodeUrls.tpl
@@ -0,0 +1,7 @@
+    public static function getSourceCodeUrls(): array
+    {
+        return [
+            'entryPoint' => '____PHPBENCHMARKS_ENTRY_POINT_URL____',
+            'template' => '____PHPBENCHMARKS_TEMPLATE_URL____'
+        ];
+    }
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/responseBody/responseBody.txt b/src/DefaultConfiguration/TemplateEngine/MainRepository/HelloWorld/responseBody/responseBody.txt
@@ -0,0 +1 @@
+Hello World !
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/README.md b/src/DefaultConfiguration/TemplateEngine/MainRepository/README.md
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/initBenchmark.sh b/src/DefaultConfiguration/TemplateEngine/MainRepository/initBenchmark.sh
diff --git a/src/DefaultConfiguration/TemplateEngine/MainRepository/vhost.conf b/src/DefaultConfiguration/TemplateEngine/MainRepository/vhost.conf
diff --git a/start.sh b/start.sh
