Improve quality on Entities

Author: njoubert-cleverage

src/Controller/Admin/ProcessScheduleCrudController.php

@@ -15,8 +15,8 @@
 
 use CleverAge\ProcessBundle\Configuration\ProcessConfiguration;
 use CleverAge\UiProcessBundle\Admin\Field\EnumField;
+use CleverAge\UiProcessBundle\Entity\Enum\ProcessScheduleType;
 use CleverAge\UiProcessBundle\Entity\ProcessSchedule;
-use CleverAge\UiProcessBundle\Entity\ProcessScheduleType;
 use CleverAge\UiProcessBundle\Form\Type\ProcessContextType;
 use CleverAge\UiProcessBundle\Manager\ProcessConfigurationsManager;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Action;

src/Entity/Enum/ProcessScheduleType.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the CleverAge/UiProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CleverAge\UiProcessBundle\Entity\Enum;
+
+enum ProcessScheduleType: string
+{
+    case CRON = 'cron';
+    case EVERY = 'every';
+}

src/Entity/LogRecord.php

@@ -13,44 +13,47 @@
 
 namespace CleverAge\UiProcessBundle\Entity;
 
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\String\UnicodeString;
 
 #[ORM\Entity]
-#[ORM\Index(columns: ['level'], name: 'idx_log_record_level')]
-#[ORM\Index(columns: ['created_at'], name: 'idx_log_record_created_at')]
+#[ORM\Index(name: 'idx_log_record_level', columns: ['level'])]
+#[ORM\Index(name: 'idx_log_record_created_at', columns: ['created_at'])]
 class LogRecord
 {
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column]
     private ?int $id = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 64)]
+    #[ORM\Column(type: Types::STRING, length: 64)]
     public readonly string $channel;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::INTEGER)]
+    #[ORM\Column(type: Types::INTEGER)]
     public readonly int $level;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 512)]
+    #[ORM\Column(type: Types::STRING, length: 512)]
     public readonly string $message;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::JSON)]
-    /** @var array<string, mixed> */
+    /** @var array<string, mixed> $context */
+    #[ORM\Column(type: Types::JSON)]
     public readonly array $context;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::DATETIME_IMMUTABLE)]
+    #[ORM\Column(type: Types::DATETIME_IMMUTABLE)]
     public readonly \DateTimeImmutable $createdAt;
 
     public function getId(): ?int
     {
         return $this->id;
     }
 
-    public function __construct(\Monolog\LogRecord $record, #[ORM\ManyToOne(targetEntity: ProcessExecution::class, cascade: ['all'])]
+    public function __construct(
+        \Monolog\LogRecord $record,
+        #[ORM\ManyToOne(targetEntity: ProcessExecution::class, cascade: ['all'])]
         #[ORM\JoinColumn(name: 'process_execution_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
-        private readonly ProcessExecution $processExecution)
-    {
+        private readonly ProcessExecution $processExecution,
+    ) {
         $this->channel = (string) (new UnicodeString($record->channel))->truncate(64);
         $this->level = $record->level->value;
         $this->message = (string) (new UnicodeString($record->message))->truncate(512);

src/Entity/ProcessExecution.php

@@ -19,8 +19,8 @@
 use Symfony\Component\String\UnicodeString;
 
 #[ORM\Entity]
-#[ORM\Index(columns: ['code'], name: 'idx_process_execution_code')]
-#[ORM\Index(columns: ['start_date'], name: 'idx_process_execution_start_date')]
+#[ORM\Index(name: 'idx_process_execution_code', columns: ['code'])]
+#[ORM\Index(name: 'idx_process_execution_start_date', columns: ['start_date'])]
 class ProcessExecution implements \Stringable
 {
     #[ORM\Id]
@@ -51,14 +51,20 @@ public function getId(): ?int
         return $this->id;
     }
 
-    public function __construct(string $code, #[ORM\Column(type: Types::STRING, length: 255)]
-        public readonly string $logFilename, ?array $context = [])
-    {
+    public function __construct(
+        string $code,
+        #[ORM\Column(type: Types::STRING, length: 255)] public readonly string $logFilename, ?array $context = [],
+    ) {
         $this->code = (string) (new UnicodeString($code))->truncate(255);
         $this->startDate = \DateTimeImmutable::createFromMutable(new \DateTime());
         $this->context = $context ?? [];
     }
 
+    public function __toString(): string
+    {
+        return \sprintf('%s (%s)', $this->id, $this->code);
+    }
+
     public function setStatus(ProcessExecutionStatus $status): void
     {
         $this->status = $status;
@@ -69,11 +75,6 @@ public function end(): void
         $this->endDate = \DateTimeImmutable::createFromMutable(new \DateTime());
     }
 
-    public function __toString(): string
-    {
-        return \sprintf('%s (%s)', $this->id, $this->code);
-    }
-
     public function addReport(string $key, mixed $value): void
     {
         $this->report[$key] = $value;

src/Entity/ProcessSchedule.php

@@ -13,19 +13,15 @@
 
 namespace CleverAge\UiProcessBundle\Entity;
 
+use CleverAge\UiProcessBundle\Entity\Enum\ProcessScheduleType;
 use CleverAge\UiProcessBundle\Repository\ProcessScheduleRepository;
 use CleverAge\UiProcessBundle\Validator\CronExpression;
 use CleverAge\UiProcessBundle\Validator\EveryExpression;
 use CleverAge\UiProcessBundle\Validator\IsValidProcessCode;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
 
-enum ProcessScheduleType: string
-{
-    case CRON = 'cron';
-    case EVERY = 'every';
-}
-
 #[ORM\Entity(repositoryClass: ProcessScheduleRepository::class)]
 class ProcessSchedule
 {
@@ -49,10 +45,10 @@ class ProcessSchedule
     )]
     private ?string $expression = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::TEXT, nullable: true)]
+    #[ORM\Column(type: Types::TEXT, nullable: true)]
     private ?string $input = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::JSON)]
+    #[ORM\Column(type: Types::JSON)]
     private string|array $context = [];
 
     public function getId(): ?int

src/Entity/User.php

@@ -13,42 +13,43 @@
 
 namespace CleverAge\UiProcessBundle\Entity;
 
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 #[ORM\Entity]
 #[ORM\Table(name: 'process_user')]
-#[ORM\Index(columns: ['email'], name: 'idx_process_user_email')]
+#[ORM\Index(name: 'idx_process_user_email', columns: ['email'])]
 class User implements UserInterface, PasswordAuthenticatedUserInterface
 {
     #[ORM\Id]
     #[ORM\GeneratedValue]
     #[ORM\Column]
     private ?int $id = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, unique: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, unique: true)]
     private ?string $email = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $firstname = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $lastname = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::JSON)]
+    #[ORM\Column(type: Types::JSON)]
     private array $roles = [];
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $password = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $timezone = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $locale = null;
 
-    #[ORM\Column(type: \Doctrine\DBAL\Types\Types::STRING, length: 255, nullable: true)]
+    #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
     private ?string $token = null;
 
     public function getId(): ?int
@@ -92,14 +93,13 @@ public function setLastname(?string $lastname): self
         return $this;
     }
 
-    /**
-     * A visual identifier that represents this user.
-     *
-     * @see UserInterface
-     */
     public function getUserIdentifier(): string
     {
-        return (string) $this->email;
+        if (null === $this->email || '' === $this->email || '0' === $this->email) {
+            throw new \LogicException('The User class must have an email.');
+        }
+
+        return $this->email;
     }
 
     public function getUsername(): string
@@ -131,16 +131,13 @@ public function setLocale(?string $locale): self
         return $this;
     }
 
-    /**
-     * @see UserInterface
-     */
     public function getRoles(): array
     {
         return array_merge(['ROLE_USER'], $this->roles);
     }
 
     /**
-     * @param array <int, string> $roles
+     * @param array<int, string> $roles
      */
     public function setRoles(array $roles): self
     {
@@ -149,9 +146,6 @@ public function setRoles(array $roles): self
         return $this;
     }
 
-    /**
-     * @see PasswordAuthenticatedUserInterface
-     */
     public function getPassword(): ?string
     {
         return $this->password;
@@ -176,20 +170,6 @@ public function setToken(?string $token): self
         return $this;
     }
 
-    /**
-     * Returning a salt is only needed, if you are not using a modern
-     * hashing algorithm (e.g. bcrypt or sodium) in your security.yaml.
-     *
-     * @see UserInterface
-     */
-    public function getSalt(): ?string
-    {
-        return null;
-    }
-
-    /**
-     * @see UserInterface
-     */
     public function eraseCredentials(): void
     {
         // If you store any temporary, sensitive data on the user, clear it here

src/Scheduler/CronScheduler.php

@@ -13,7 +13,7 @@
 
 namespace CleverAge\UiProcessBundle\Scheduler;
 
-use CleverAge\UiProcessBundle\Entity\ProcessScheduleType;
+use CleverAge\UiProcessBundle\Entity\Enum\ProcessScheduleType;
 use CleverAge\UiProcessBundle\Message\CronProcessMessage;
 use CleverAge\UiProcessBundle\Repository\ProcessScheduleRepository;
 use Psr\Log\LoggerInterface;