feat: better code coverage scipt + docs + cleanup (#211)

Author: COil

bin/coverage-checker.php

@@ -5,12 +5,16 @@
 declare(strict_types=1);
 
 $argv = $argv ?? [];
-$inputFile = $argv[1];
+if (count($argv) !== 3) {
+    throw new InvalidArgumentException('Two arguments are required by this script: 1) the clover file report path. 2) the code coverage threshold.');
+}
+
+[,$inputFile, $threshold] = $argv;
 
-if (!is_numeric($argv[2])) {
+if (!is_numeric($threshold)) {
     throw new InvalidArgumentException('An integer checked percentage must be given as second parameter');
 }
-$percentage = min(100, max(0, (int) $argv[2]));
+$percentage = min(100, max(0, (int) $threshold));
 
 if (!file_exists($inputFile)) {
     throw new InvalidArgumentException('Invalid input file provided');

src/Controller/SlugifyAction.php

@@ -22,7 +22,7 @@ final class SlugifyAction extends AbstractController
      * Simple API endpoint returning JSON. For a more serious API, please use API Platform 🕸.
      * We can use the MapQueryParameter attribute to inject GET parameters.
      *
-     * @see https://api-platform.com/
+     * @see https://api-platform.com
      */
     #[Route(path: '/api/slugify', name: self::class)]
     public function __invoke(StringHelper $stringHelper, #[MapQueryParameter] string $title): Response

src/Form/Type/RegisterForm.php

@@ -43,6 +43,9 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
         ;
     }
 
+    /**
+     * @see https://www.strangebuzz.com/en/blog/disable-the-html5-validation-of-all-your-symfony-forms-with-a-feature-flag
+     */
     public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([

src/Twig/Extension/MarkdownExtension.php

@@ -17,7 +17,7 @@ public function __construct(
     }
 
     /**
-     * Add the missing anchors on demo website homepage displaying the Github README.
+     * Add the missing anchors on demo website homepage displaying the GitHub README.
      *
      * @see https://microsymfony.ovh
      * @see https://github.com/strangebuzz/MicroSymfony/blob/main/README.md?plain=1
@@ -30,7 +30,7 @@ public function addHeadersAnchors(string $html): string
 
         // Allow to have the same "buggy" anchors as GitHub
         /** @var \DOMNodeList<\DOMNode> $tags */
-        $tags = (new \DOMXPath($dom))->query('//h2 | //h3');
+        $tags = new \DOMXPath($dom)->query('//h2 | //h3');
         foreach ($tags as $headerTag) {
             $slug = $this->stringHelper->slugify($headerTag->textContent);
             /** @var \DOMElement $headerTag */

tests/Functional/Controller/FormActionTest.php

@@ -8,7 +8,7 @@
 
 final class FormActionTest extends WebTestCase
 {
-    private const FORM_SUBMIT_BUTTON_ID = 'register_form_save';
+    private const string FORM_SUBMIT_BUTTON_ID = 'register_form_save';
 
     public function testFormValidationErrors(): void
     {

tests/Functional/Controller/StaticRoutesSmokeTest.php

@@ -19,9 +19,7 @@ final class StaticRoutesSmokeTest extends WebTestCase
     public function testRoutesDoNotReturnInternalError(string $httpMethod, string $routeName, string $routePath): void
     {
         $client = self::createClient();
-
         $client->request($httpMethod, $routePath);
-
         $response = $client->getResponse();
         self::assertLessThan(
             500,
@@ -39,9 +37,7 @@ public static function provideRouteCollection(): \Generator
 
         /** @var RouterInterface $router */
         $router = self::getContainer()->get(RouterInterface::class);
-
         $routes = $router->getRouteCollection();
-
         self::ensureKernelShutdown();
 
         if (!$routes->count()) {
@@ -57,8 +53,7 @@ public static function provideRouteCollection(): \Generator
     public static function extractRoutesFromRouter(RouterInterface $router): \Generator
     {
         foreach ($router->getRouteCollection() as $routeName => $route) {
-            $compiledRoute = $route->compile();
-            $variables = $compiledRoute->getVariables();
+            $variables = $route->compile()->getVariables();
             if (\count($variables) > 0) {
                 $defaults = $route->getDefaults();
                 $defaultsKeys = array_keys($defaults);
@@ -71,6 +66,8 @@ public static function extractRoutesFromRouter(RouterInterface $router): \Genera
 
             $methods = $route->getMethods();
             if (!$methods) {
+                // If we get there, it is because your route doesn't have methods requirment.
+                // You can add one by adding ` methods: ['GET']` to your Route attribute.
                 $methods[] = 'GET';
             }