Merge pull request #532 from derrabus/improvement/final-readonly

Use final and readonly where possible
doctrine · Sep 26, 2023 · 82d7d1e · 82d7d1e
2 parents 3a4eb99 + 0bd4b40
commit 82d7d1e
Show file tree

Hide file tree

Showing 67 changed files with 279 additions and 208 deletions.
diff --git a/lib/Application.php b/lib/Application.php
@@ -28,7 +28,7 @@
 use function realpath;
 use function sprintf;
 
-class Application
+final readonly class Application
 {
     public const ENV_PROD    = 'prod';
     public const ENV_STAGING = 'staging';

diff --git a/lib/Assets/AssetIntegrityGenerator.php b/lib/Assets/AssetIntegrityGenerator.php
@@ -10,13 +10,16 @@
 use function hash;
 use function realpath;
 
+/** @final */
 class AssetIntegrityGenerator
 {
     /** @var string[] */
     private array $cache = [];
 
-    public function __construct(private string $sourceDir, private string $webpackBuildDir)
-    {
+    public function __construct(
+        private readonly string $sourceDir,
+        private readonly string $webpackBuildDir,
+    ) {
     }
 
     public function getAssetIntegrity(string $path, string|null $rootPath = null): string

diff --git a/lib/Cache/CacheClearer.php b/lib/Cache/CacheClearer.php
@@ -10,7 +10,7 @@
 use function glob;
 use function sprintf;
 
-class CacheClearer
+final readonly class CacheClearer
 {
     public function __construct(
         private Filesystem $filesystem,

diff --git a/lib/Commands/BuildAllCommand.php b/lib/Commands/BuildAllCommand.php
@@ -20,11 +20,11 @@
 use function is_string;
 use function sprintf;
 
-class BuildAllCommand extends Command
+final class BuildAllCommand extends Command
 {
     public function __construct(
-        private string $rootDir,
-        private string $env,
+        private readonly string $rootDir,
+        private readonly string $env,
     ) {
         parent::__construct();
     }

diff --git a/lib/Commands/BuildDocsCommand.php b/lib/Commands/BuildDocsCommand.php
@@ -14,10 +14,11 @@
 use function is_bool;
 use function is_string;
 
-class BuildDocsCommand extends Command
+final class BuildDocsCommand extends Command
 {
-    public function __construct(private BuildDocs $buildDocs)
-    {
+    public function __construct(
+        private readonly BuildDocs $buildDocs,
+    ) {
         parent::__construct();
     }
 

diff --git a/lib/Commands/BuildWebsiteCommand.php b/lib/Commands/BuildWebsiteCommand.php
@@ -26,7 +26,7 @@
 use function sprintf;
 use function time;
 
-class BuildWebsiteCommand extends Command
+final class BuildWebsiteCommand extends Command
 {
     private const WATCH_DIRS = [
         'config',
@@ -37,9 +37,9 @@ class BuildWebsiteCommand extends Command
     ];
 
     public function __construct(
-        private WebsiteBuilder $websiteBuilder,
-        private string $rootDir,
-        private string $env,
+        private readonly WebsiteBuilder $websiteBuilder,
+        private readonly string $rootDir,
+        private readonly string $env,
     ) {
         parent::__construct();
     }

diff --git a/lib/Commands/BuildWebsiteDataCommand.php b/lib/Commands/BuildWebsiteDataCommand.php
@@ -15,14 +15,14 @@
 
 use function sprintf;
 
-class BuildWebsiteDataCommand extends Command
+final class BuildWebsiteDataCommand extends Command
 {
     public function __construct(
-        private ProjectDataBuilder $projectDataBuilder,
-        private ProjectContributorDataBuilder $projectContributorDataBuilder,
-        private ContributorDataBuilder $contributorDataBuilder,
-        private BlogPostDataBuilder $blogPostDataBuilder,
-        private WebsiteDataWriter $dataWriter,
+        private readonly ProjectDataBuilder $projectDataBuilder,
+        private readonly ProjectContributorDataBuilder $projectContributorDataBuilder,
+        private readonly ContributorDataBuilder $contributorDataBuilder,
+        private readonly BlogPostDataBuilder $blogPostDataBuilder,
+        private readonly WebsiteDataWriter $dataWriter,
     ) {
         parent::__construct();
     }

diff --git a/lib/Commands/ClearBuildCacheCommand.php b/lib/Commands/ClearBuildCacheCommand.php
@@ -14,10 +14,13 @@
 use function is_string;
 use function sprintf;
 
-class ClearBuildCacheCommand extends Command
+final class ClearBuildCacheCommand extends Command
 {
-    public function __construct(private CacheClearer $cacheClearer, private string $rootDir, private string $env)
-    {
+    public function __construct(
+        private readonly CacheClearer $cacheClearer,
+        private readonly string $rootDir,
+        private readonly string $env,
+    ) {
         parent::__construct();
     }
 

diff --git a/lib/Commands/SyncRepositoriesCommand.php b/lib/Commands/SyncRepositoriesCommand.php
@@ -12,11 +12,11 @@
 
 use function sprintf;
 
-class SyncRepositoriesCommand extends Command
+final class SyncRepositoriesCommand extends Command
 {
     public function __construct(
-        private ProjectDataRepository $projectDataRepository,
-        private ProjectGitSyncer $projectGitSyncer,
+        private readonly ProjectDataRepository $projectDataRepository,
+        private readonly ProjectGitSyncer $projectGitSyncer,
     ) {
         parent::__construct();
     }

diff --git a/lib/Controllers/AtomController.php b/lib/Controllers/AtomController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\BlogPost;
 use Doctrine\Website\Repositories\BlogPostRepository;
 
-class AtomController
+final readonly class AtomController
 {
     /** @param BlogPostRepository<BlogPost> $blogPostRepository */
-    public function __construct(private BlogPostRepository $blogPostRepository)
-    {
+    public function __construct(
+        private BlogPostRepository $blogPostRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/BlogController.php b/lib/Controllers/BlogController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\BlogPost;
 use Doctrine\Website\Repositories\BlogPostRepository;
 
-class BlogController
+final readonly class BlogController
 {
     /** @param BlogPostRepository<BlogPost> $blogPostRepository */
-    public function __construct(private BlogPostRepository $blogPostRepository)
-    {
+    public function __construct(
+        private BlogPostRepository $blogPostRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/ConsultingController.php b/lib/Controllers/ConsultingController.php
@@ -9,11 +9,12 @@
 use Doctrine\Website\Model\TeamMember;
 use Doctrine\Website\Repositories\TeamMemberRepository;
 
-class ConsultingController
+final readonly class ConsultingController
 {
     /** @param TeamMemberRepository<TeamMember> $teamMemberRepository */
-    public function __construct(private TeamMemberRepository $teamMemberRepository)
-    {
+    public function __construct(
+        private TeamMemberRepository $teamMemberRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/DocumentationController.php b/lib/Controllers/DocumentationController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\Project;
 use Doctrine\Website\Repositories\ProjectRepository;
 
-class DocumentationController
+final readonly class DocumentationController
 {
     /** @param ProjectRepository<Project> $projectRepository */
-    public function __construct(private ProjectRepository $projectRepository)
-    {
+    public function __construct(
+        private ProjectRepository $projectRepository,
+    ) {
     }
 
     public function view(string $docsSlug, string $docsVersion): Response

diff --git a/lib/Controllers/HomepageController.php b/lib/Controllers/HomepageController.php
@@ -15,7 +15,7 @@
 use Doctrine\Website\Repositories\PartnerRepository;
 use Doctrine\Website\Repositories\ProjectRepository;
 
-class HomepageController
+final readonly class HomepageController
 {
     /**
      * @param BlogPostRepository<BlogPost>         $blogPostRepository

diff --git a/lib/Controllers/PartnersController.php b/lib/Controllers/PartnersController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\Partner;
 use Doctrine\Website\Repositories\PartnerRepository;
 
-final class PartnersController
+final readonly class PartnersController
 {
     /** @param PartnerRepository<Partner> $partnerRepository */
-    public function __construct(private PartnerRepository $partnerRepository)
-    {
+    public function __construct(
+        private PartnerRepository $partnerRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/ProjectController.php b/lib/Controllers/ProjectController.php
@@ -10,7 +10,7 @@
 use Doctrine\Website\Repositories\ProjectContributorRepository;
 use Doctrine\Website\Repositories\ProjectRepository;
 
-class ProjectController
+final readonly class ProjectController
 {
     /**
      * @param ProjectRepository<Project>                       $projectRepository

diff --git a/lib/Controllers/SitemapController.php b/lib/Controllers/SitemapController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\SitemapPage;
 use Doctrine\Website\Repositories\SitemapPageRepository;
 
-class SitemapController
+final readonly class SitemapController
 {
     /** @param SitemapPageRepository<SitemapPage> $sitemapPageRepository */
-    public function __construct(private SitemapPageRepository $sitemapPageRepository)
-    {
+    public function __construct(
+        private SitemapPageRepository $sitemapPageRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/SponsorshipController.php b/lib/Controllers/SponsorshipController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\Sponsor;
 use Doctrine\Website\Repositories\SponsorRepository;
 
-class SponsorshipController
+final readonly class SponsorshipController
 {
     /** @param SponsorRepository<Sponsor> $sponsorRepository */
-    public function __construct(private SponsorRepository $sponsorRepository)
-    {
+    public function __construct(
+        private SponsorRepository $sponsorRepository,
+    ) {
     }
 
     public function index(): Response

diff --git a/lib/Controllers/TeamController.php b/lib/Controllers/TeamController.php
@@ -8,11 +8,12 @@
 use Doctrine\Website\Model\Contributor;
 use Doctrine\Website\Repositories\ContributorRepository;
 
-class TeamController
+final readonly class TeamController
 {
     /** @param ContributorRepository<Contributor> $contributorRepository */
-    public function __construct(private ContributorRepository $contributorRepository)
-    {
+    public function __construct(
+        private ContributorRepository $contributorRepository,
+    ) {
     }
 
     public function maintainers(): Response

diff --git a/lib/DataBuilder/BlogPostDataBuilder.php b/lib/DataBuilder/BlogPostDataBuilder.php
@@ -6,12 +6,13 @@
 
 use Doctrine\StaticWebsiteGenerator\SourceFile\SourceFileFilesystemReader;
 
-class BlogPostDataBuilder implements DataBuilder
+final readonly class BlogPostDataBuilder implements DataBuilder
 {
     public const DATA_FILE = 'blog_posts';
 
-    public function __construct(private SourceFileFilesystemReader $sourceFileFilesystemReader)
-    {
+    public function __construct(
+        private SourceFileFilesystemReader $sourceFileFilesystemReader,
+    ) {
     }
 
     public function getName(): string

diff --git a/lib/DataBuilder/ContributorDataBuilder.php b/lib/DataBuilder/ContributorDataBuilder.php
@@ -7,13 +7,14 @@
 use Doctrine\Website\Model\ProjectContributor;
 use Doctrine\Website\Repositories\ProjectContributorRepository;
 
-class ContributorDataBuilder implements DataBuilder
+final readonly class ContributorDataBuilder implements DataBuilder
 {
     public const DATA_FILE = 'contributors';
 
     /** @param ProjectContributorRepository<ProjectContributor> $projectContributorRepository */
-    public function __construct(private ProjectContributorRepository $projectContributorRepository)
-    {
+    public function __construct(
+        private ProjectContributorRepository $projectContributorRepository,
+    ) {
     }
 
     public function getName(): string

diff --git a/lib/DataBuilder/ProjectContributorDataBuilder.php b/lib/DataBuilder/ProjectContributorDataBuilder.php
@@ -10,7 +10,7 @@
 use Doctrine\Website\Repositories\ProjectRepository;
 use Doctrine\Website\Repositories\TeamMemberRepository;
 
-class ProjectContributorDataBuilder implements DataBuilder
+final readonly class ProjectContributorDataBuilder implements DataBuilder
 {
     public const DATA_FILE = 'project_contributors';
 

diff --git a/lib/DataBuilder/ProjectDataBuilder.php b/lib/DataBuilder/ProjectDataBuilder.php
@@ -21,7 +21,7 @@
 use function strnatcmp;
 use function usort;
 
-class ProjectDataBuilder implements DataBuilder
+final readonly class ProjectDataBuilder implements DataBuilder
 {
     public const DATA_FILE = 'projects';
 

diff --git a/lib/DataBuilder/WebsiteData.php b/lib/DataBuilder/WebsiteData.php
@@ -4,11 +4,13 @@
 
 namespace Doctrine\Website\DataBuilder;
 
-class WebsiteData
+final readonly class WebsiteData
 {
     /** @param mixed[] $data */
-    public function __construct(private string $name, private array $data)
-    {
+    public function __construct(
+        private string $name,
+        private array $data,
+    ) {
     }
 
     public function getName(): string

diff --git a/lib/DataBuilder/WebsiteDataReader.php b/lib/DataBuilder/WebsiteDataReader.php
@@ -11,10 +11,12 @@
 use function json_decode;
 use function sprintf;
 
+/** @final */
 class WebsiteDataReader
 {
-    public function __construct(private string $cacheDir)
-    {
+    public function __construct(
+        private readonly string $cacheDir,
+    ) {
     }
 
     public function read(string $file): WebsiteData

diff --git a/lib/DataBuilder/WebsiteDataWriter.php b/lib/DataBuilder/WebsiteDataWriter.php
@@ -13,10 +13,11 @@
 use const JSON_PRETTY_PRINT;
 use const JSON_UNESCAPED_SLASHES;
 
-class WebsiteDataWriter
+final readonly class WebsiteDataWriter
 {
-    public function __construct(private string $cacheDir)
-    {
+    public function __construct(
+        private string $cacheDir,
+    ) {
     }
 
     public function write(WebsiteData $websiteData): void