Merge branch 'cs-fixes'

codedmonkey · codedmonkey · commit efa82f5d11ce · 2025-03-25T17:49:43.000+01:00
diff --git a/.dockerignore b/.dockerignore
@@ -1,6 +1,10 @@
 /.github/
 /.idea/
+/.phpunit.cache/
+/config/dirigent.json
+/config/dirigent.php
 /config/dirigent.yaml
+/config/dirigent.yml
 /config/packages/dirigent.yaml
 /node_modules/
 /public/build/
diff --git a/.gitattributes b/.gitattributes
@@ -1,6 +1,6 @@
 # Documentation files
 docs/** linguist-documentation
-changelogd.md linguist-documentation
+changelog.md linguist-documentation
 license.md linguist-documentation
 readme.md linguist-documentation
 
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
 /.env
 /compose.override.yaml
+/config/dirigent.json
+/config/dirigent.php
 /config/dirigent.yaml
+/config/dirigent.yml
 /config/packages/dirigent.yaml
 /storage/
 
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -3,11 +3,16 @@ parameters:
     paths:
         - bin/
         - config/
+        - migrations/
         - public/
         - src/
         - tests/
     excludePaths:
         - tests/bootstrap.php
     ignoreErrors:
-        - '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::children\(\).#'
-        - '#Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+::\$id \(int\|null\) is never assigned int so it can be removed from the property type.#'
+        - '#^Property CodedMonkey\\Dirigent\\Doctrine\\Entity\\[a-zA-Z]+\:\:\$id \(int\|null\) is never assigned int so it can be removed from the property type\.$#'
+        -
+            message: '#^Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition\:\:children\(\)\.$#'
+            identifier: method.notFound
+            count: 1
+            path: src/DependencyInjection/DirigentConfiguration.php
diff --git a/phpunit.dist.xml b/phpunit.dist.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         backupGlobals="false"
-         colors="true"
-         bootstrap="tests/bootstrap.php"
-         cacheDirectory=".phpunit.cache"
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="tests/bootstrap.php"
+    cacheDirectory=".phpunit.cache"
+    colors="true"
 >
     <php>
         <ini name="display_errors" value="1" />
@@ -26,7 +26,7 @@
         </testsuite>
     </testsuites>
 
-    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+    <source restrictNotices="true" restrictWarnings="true">
         <include>
             <directory>src</directory>
         </include>
diff --git a/phpunit.docker.xml b/phpunit.docker.xml
@@ -1,9 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         colors="true"
-         bootstrap="tests/bootstrap.php"
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="tests/bootstrap.php"
+    cacheDirectory=".phpunit.cache"
+    colors="true"
 >
     <php>
         <ini name="display_errors" value="1" />
diff --git a/src/EventListener/DashboardRoutingListener.php b/src/EventListener/DashboardRoutingListener.php
@@ -19,7 +19,7 @@ public function __construct(
     }
 
     #[AsEventListener]
-    public function onKernelRequest(RequestEvent $event): void
+    public function redirectPrettyDashboardUrls(RequestEvent $event): void
     {
         $request = $event->getRequest();
 
diff --git a/src/EventListener/SecurityListener.php b/src/EventListener/SecurityListener.php
@@ -13,7 +13,7 @@
 use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials;
 use Symfony\Component\Security\Http\Event\CheckPassportEvent;
 
-readonly class SecurityEventListener
+readonly class SecurityListener
 {
     public function __construct(
         private AccessTokenRepository $accessTokenRepository,
diff --git a/src/Kernel.php b/src/Kernel.php
@@ -20,23 +20,24 @@ protected function configureContainer(ContainerConfigurator $container): void
 
         $container->import($configDir . '/packages/*.yaml');
         $container->import($configDir . '/services.yaml');
-        $container->import($configDir . '/dirigent.{json,php,yaml}');
+        $container->import($configDir . '/dirigent.{json,php,yml,yaml}');
 
         if (isset($_SERVER['DIRIGENT_IMAGE'])) {
-            $container->import('/srv/config/*.{json,php,yaml}');
+            $container->import('/srv/config/*.{json,php,yml,yaml}');
         }
     }
 
+    protected function build(ContainerBuilder $container): void
+    {
+        $container->registerExtension(new DirigentExtension());
+    }
+
     public function boot(): void
     {
         parent::boot();
 
+        // Set Composer env vars
         $_SERVER['COMPOSER_CACHE_DIR'] = $this->container->getParameter('dirigent.storage.path') . '/composer-cache';
         $_SERVER['COMPOSER_HOME'] = $this->container->getParameter('dirigent.storage.path') . '/composer';
     }
-
-    protected function build(ContainerBuilder $container): void
-    {
-        $container->registerExtension(new DirigentExtension());
-    }
 }
diff --git a/src/Package/PackageMetadataResolver.php b/src/Package/PackageMetadataResolver.php
@@ -403,8 +403,8 @@ private function updateReadme(Version $version, VcsDriverInterface $driver): voi
 
                     break;
             }
-        } catch (\Exception $e) {
-            throw $e; // todo handle politely
+        } catch (\Exception $exception) {
+            throw $exception; // todo handle politely
         }
     }
 
diff --git a/src/Package/PackageVcsRepositoryValidator.php b/src/Package/PackageVcsRepositoryValidator.php
@@ -67,8 +67,8 @@ public function validate(Package $package): array
             }
 
             return $result;
-        } catch (\Exception $e) {
-            return ['error' => '[' . $e::class . '] ' . $e->getMessage()];
+        } catch (\Exception $exception) {
+            return ['error' => '[' . $exception::class . '] ' . $exception->getMessage()];
         }
     }
 
diff --git a/templates/dashboard/packages/list.html.twig b/templates/dashboard/packages/list.html.twig
@@ -14,11 +14,9 @@
           Add Package
         </button>
         <ul class="dropdown-menu">
-          {% set addVcsUrl = ea_url()
-            .setRoute('dashboard_packages_add_vcs') %}
+          {% set addVcsUrl = dashboard_path('dashboard_packages_add_vcs') %}
           <li><a class="dropdown-item" href="{{ addVcsUrl }}">Add VCS repository</a></li>
-          {% set addMirroringUrl = ea_url()
-            .setRoute('dashboard_packages_add_mirroring') %}
+          {% set addMirroringUrl = dashboard_path('dashboard_packages_add_mirroring') %}
           <li><a class="dropdown-item" href="{{ addMirroringUrl }}">Mirror from registry</a></li>
         </ul>
       </div>
@@ -29,10 +27,9 @@
 {% block page_content %}
   <div class="d-grid gap-3">
     {% for package in packages %}
-      {% set packageInfoUrl = ea_url()
-        .setRoute('dashboard_packages_info', {packageName: package.name}) %}
       <div class="card">
         <div class="card-body py-2">
+          {% set packageInfoUrl = dashboard_path('dashboard_packages_info', {packageName: package.name}) %}
           <a href="{{ packageInfoUrl }}"><h5 class="card-title">{{ package.name }}</h5></a>
           {% if package.mirrorRegistry %}
             <p class="card-text mb-1 text-body-secondary">Mirrored from {{ package.mirrorRegistry.name }}</p>
diff --git a/templates/dashboard/packages/package_header.html.twig b/templates/dashboard/packages/package_header.html.twig
@@ -2,21 +2,18 @@
 
 <ul class="nav nav-pills nav-justified d-grid d-md-flex gap-1 pb-3 mb-3 border-bottom">
   <li class="nav-item">
-    {% set packageInfoUrl = ea_url()
-      .setRoute('dashboard_packages_info', {packageName: package.name}) %}
+    {% set packageInfoUrl = dashboard_path('dashboard_packages_info', {packageName: package.name}) %}
     <a {% if currentPage == 'info' %}class="nav-link active" aria-current="page"{% else %}class="nav-link text-primary"{% endif%} href="{{ packageInfoUrl }}">{{ 'Info'|trans }}</a>
   </li>
   <li class="nav-item">
-    {% set packageVersionsUrl = ea_url()
-      .setRoute('dashboard_packages_versions', {packageName: package.name}) %}
+    {% set packageVersionsUrl = dashboard_path('dashboard_packages_versions', {packageName: package.name}) %}
     <a {% if currentPage == 'versions' %}class="nav-link active" aria-current="page"{% else %}class="nav-link text-primary"{% endif%} href="{{ packageVersionsUrl }}">{{ 'Versions'|trans }}</a>
   </li>
   <li class="nav-item">
     <span class="nav-link disabled">{{ 'Dependants'|trans }}</span>
   </li>
   <li class="nav-item">
-    {% set packageVersionsUrl = ea_url()
-      .setRoute('dashboard_packages_statistics', {packageName: package.name}) %}
+    {% set packageVersionsUrl = dashboard_path('dashboard_packages_statistics', {packageName: package.name}) %}
     <a {% if currentPage == 'statistics' %}class="nav-link active" aria-current="page"{% else %}class="nav-link text-primary"{% endif%} href="{{ packageVersionsUrl }}">{{ 'Statistics'|trans }}</a>
   </li>
 </ul>
diff --git a/templates/dashboard/packages/package_versions.html.twig b/templates/dashboard/packages/package_versions.html.twig
@@ -7,8 +7,7 @@
 
   <div class="list-group list-group-flush mb-3">
     {% for version in versions %}
-      {% set packageVersionInfoUrl = ea_url()
-        .setRoute('dashboard_packages_info', {packageName: package.name, packageVersion: version.version}) %}
+      {% set packageVersionInfoUrl = dashboard_path('dashboard_packages_info', {packageName: package.name, packageVersion: version.version}) %}
       <a href="{{ packageVersionInfoUrl }}" class="list-group-item">
         <div class="d-flex justify-content-between">
           <span>
diff --git a/templates/dashboard/reset_password/sent.html.twig b/templates/dashboard/reset_password/sent.html.twig
@@ -21,8 +21,7 @@
         If an account matching your email exists, then an email was just sent that contains a link that you can use to reset your password.
         This link will expire in {{ resetToken.expirationMessageKey|trans(resetToken.expirationMessageData, 'ResetPasswordBundle') }}.
       </p>
-      {% set requestUrl = ea_url()
-        .setRoute('dashboard_reset_password_request') %}
+      {% set requestUrl = dashboard_path('dashboard_reset_password_request') %}
       <p>If you don't receive an email please check your spam folder or <a href="{{ requestUrl }}">try again</a>.</p>
     </section>
   </div>
diff --git a/tests/FunctionalTests/DashboardPackagesControllerTest.php b/tests/FunctionalTests/DashboardPackagesControllerTest.php
@@ -2,23 +2,17 @@
 
 namespace CodedMonkey\Dirigent\Tests\FunctionalTests;
 
-use CodedMonkey\Dirigent\Doctrine\Entity\User;
 use CodedMonkey\Dirigent\Doctrine\Repository\PackageRepository;
-use CodedMonkey\Dirigent\Doctrine\Repository\UserRepository;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
 class DashboardPackagesControllerTest extends WebTestCase
 {
+    use WebTestCaseTrait;
+
     public function testStatistics(): void
     {
         $client = static::createClient();
-
-        /** @var UserRepository $userRepository */
-        $userRepository = $client->getContainer()->get(UserRepository::class);
-
-        /** @var User $user */
-        $user = $userRepository->findOneByUsername('user');
-        $client->loginUser($user);
+        $this->loginUser();
 
         $client->request('GET', '/?routeName=dashboard_packages_statistics&routeParams[packageName]=psr/log');
 
@@ -38,13 +32,7 @@ public function testStatistics(): void
     public function testAddVcsRepository(): void
     {
         $client = static::createClient();
-
-        /** @var UserRepository $userRepository */
-        $userRepository = $client->getContainer()->get(UserRepository::class);
-
-        /** @var User $user */
-        $user = $userRepository->findOneByUsername('owner');
-        $client->loginUser($user);
+        $this->loginUser('admin');
 
         $client->request('GET', '/?routeName=dashboard_packages_add_vcs');
         $client->submitForm('Add VCS repository', [
@@ -57,21 +45,15 @@ public function testAddVcsRepository(): void
         $packageRepository = $client->getContainer()->get(PackageRepository::class);
 
         $package = $packageRepository->findOneByName('psr/container');
-        self::assertNotNull($package, 'A package was created');
+        self::assertNotNull($package, 'A package was created.');
 
         $packageRepository->remove($package, true);
     }
 
     public function testEdit(): void
     {
         $client = static::createClient();
-
-        /** @var UserRepository $userRepository */
-        $userRepository = $client->getContainer()->get(UserRepository::class);
-
-        /** @var User $user */
-        $user = $userRepository->findOneByUsername('owner');
-        $client->loginUser($user);
+        $this->loginUser('admin');
 
         $client->request('GET', '/?routeName=dashboard_packages_edit&routeParams[packageName]=psr/log');
         $client->submitForm('Save changes');
diff --git a/tests/FunctionalTests/DashboardRootControllerTest.php b/tests/FunctionalTests/DashboardRootControllerTest.php
@@ -2,22 +2,16 @@
 
 namespace CodedMonkey\Dirigent\Tests\FunctionalTests;
 
-use CodedMonkey\Dirigent\Doctrine\Entity\User;
-use CodedMonkey\Dirigent\Doctrine\Repository\UserRepository;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
 class DashboardRootControllerTest extends WebTestCase
 {
+    use WebTestCaseTrait;
+
     public function testIndex(): void
     {
         $client = static::createClient();
-
-        /** @var UserRepository $userRepository */
-        $userRepository = $client->getContainer()->get(UserRepository::class);
-
-        /** @var User $user */
-        $user = $userRepository->findOneByUsername('user');
-        $client->loginUser($user);
+        $this->loginUser();
 
         $client->request('GET', '/');
 
diff --git a/tests/FunctionalTests/WebTestCaseTrait.php b/tests/FunctionalTests/WebTestCaseTrait.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace CodedMonkey\Dirigent\Tests\FunctionalTests;
+
+use CodedMonkey\Dirigent\Doctrine\Entity\User;
+use CodedMonkey\Dirigent\Doctrine\Repository\UserRepository;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+
+trait WebTestCaseTrait
+{
+    protected function loginUser(string $username = 'user'): User
+    {
+        /** @var KernelBrowser $client */
+        $client = static::getClient();
+        /** @var UserRepository $userRepository */
+        $userRepository = $client->getContainer()->get(UserRepository::class);
+
+        /** @var User $user */
+        $user = $userRepository->findOneByUsername($username);
+        $client->loginUser($user);
+
+        return $user;
+    }
+}
diff --git a/tests/PublicKernel.php b/tests/PublicKernel.php
@@ -11,6 +11,11 @@ protected function configureContainer(ContainerConfigurator $container): void
     {
         parent::configureContainer($container);
 
-        $container->import(__DIR__ . '/config/public/*.yaml');
+        $container->extension('dirigent', [
+            'security' => [
+                'public' => true,
+                'registration' => true,
+            ],
+        ]);
     }
 }
diff --git a/tests/config/public/conductor.yaml b/tests/config/public/conductor.yaml
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,8 +2,8 @@
   "include": ["assets/**/*"],
   "compilerOptions": {
     "noImplicitAny": true,
-    "module": "es6",
-    "target": "es5",
+    "module": "esnext",
+    "target": "es6",
     "jsx": "react",
     "allowJs": true,
     "moduleResolution": "node"

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public function __construct(`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`#[AsEventListener]`
`22`		`- public function onKernelRequest(RequestEvent $event): void`
	`22`	`+ public function redirectPrettyDashboardUrls(RequestEvent $event): void`
`23`	`23`	`{`
`24`	`24`	`$request = $event->getRequest();`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\PasswordCredentials;`
`14`	`14`	`use Symfony\Component\Security\Http\Event\CheckPassportEvent;`
`15`	`15`
`16`		`-readonly class SecurityEventListener`
	`16`	`+readonly class SecurityListener`
`17`	`17`	`{`
`18`	`18`	`public function __construct(`
`19`	`19`	`private AccessTokenRepository $accessTokenRepository,`
Original file line number	Diff line number	Diff line change
`@@ -20,23 +20,24 @@ protected function configureContainer(ContainerConfigurator $container): void`
`20`	`20`
`21`	`21`	`$container->import($configDir . '/packages/*.yaml');`
`22`	`22`	`$container->import($configDir . '/services.yaml');`
`23`		`- $container->import($configDir . '/dirigent.{json,php,yaml}');`
	`23`	`+ $container->import($configDir . '/dirigent.{json,php,yml,yaml}');`
`24`	`24`
`25`	`25`	`if (isset($_SERVER['DIRIGENT_IMAGE'])) {`
`26`		`- $container->import('/srv/config/*.{json,php,yaml}');`
	`26`	`+ $container->import('/srv/config/*.{json,php,yml,yaml}');`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
	`30`	`+ protected function build(ContainerBuilder $container): void`
	`31`	`+ {`
	`32`	`+ $container->registerExtension(new DirigentExtension());`
	`33`	`+ }`
	`34`	`+`
`30`	`35`	`public function boot(): void`
`31`	`36`	`{`
`32`	`37`	`parent::boot();`
`33`	`38`
	`39`	`+ // Set Composer env vars`
`34`	`40`	`$_SERVER['COMPOSER_CACHE_DIR'] = $this->container->getParameter('dirigent.storage.path') . '/composer-cache';`
`35`	`41`	`$_SERVER['COMPOSER_HOME'] = $this->container->getParameter('dirigent.storage.path') . '/composer';`
`36`	`42`	`}`
`37`		`-`
`38`		`- protected function build(ContainerBuilder $container): void`
`39`		`- {`
`40`		`- $container->registerExtension(new DirigentExtension());`
`41`		`- }`
`42`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -403,8 +403,8 @@ private function updateReadme(Version $version, VcsDriverInterface $driver): voi`
`403`	`403`
`404`	`404`	`break;`
`405`	`405`	`}`
`406`		`- } catch (\Exception $e) {`
`407`		`- throw $e; // todo handle politely`
	`406`	`+ } catch (\Exception $exception) {`
	`407`	`+ throw $exception; // todo handle politely`
`408`	`408`	`}`
`409`	`409`	`}`
`410`	`410`