Allow comments & empty lines in baseline (#29)

Author: odolbeau

README.md

@@ -45,3 +45,7 @@ return [
     Tiime\TestedRoutesCheckerBundle\TiimeTestedRoutesCheckerBundle::class => ['dev' => true, 'test' => true],
 ];
 ```
+
+## Using baseline to ignore some routes
+
+You can ignore some routes with a `.tiime-trc-baseline` file with 1 route per line.

src/IgnoredRoutesStorage.php

@@ -53,6 +53,18 @@ public function getRoutes(): array
             throw new \RuntimeException('Unable to load ignored routes from given file.');
         }
 
+        $routes = array_filter($routes, static function (string $route): bool {
+            return !str_starts_with($route, '#') && '' !== $route;
+        });
+
+        $routes = array_map(static function (string $route): string {
+            if (false === $pos = stripos($route, ' #')) {
+                return $route;
+            }
+
+            return mb_substr($route, 0, $pos);
+        }, $routes);
+
         return array_values(array_unique($routes));
     }
 }

tests/IgnoredRoutesStorageTest.php

@@ -26,8 +26,10 @@ public function testStorage(): void
         $this->assertSame([], $storage->getRoutes());
 
         $storage->saveRoute('route1');
-        $storage->saveRoute('route2');
+        $storage->saveRoute('route2 # This comment will be ignored');
+        $storage->saveRoute(''); // Empty line will be ignored
         $storage->saveRoute('route3');
+        $storage->saveRoute('# This is a comment which will be ignored');
         $storage->saveRoute('route2');
         $storage->saveRoutes(['route2', 'route4', 'route5']);