PrimaryKey attribute

src/Attribute/PrimaryKey.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class PrimaryKey
+{
+    public array $columns;
+
+    public function __construct(string ...$columns)
+    {
+        if (\count($columns) > 1) {
+            throw new \CoolBeans\Exception\PrimaryKeyMultipleColumnsNotImplemented('Multiple column PrimaryKey is not implemented yet.');
+        }
+
+        $this->columns = $columns;
+    }
+}

src/Command/SqlGeneratorCommand.php

@@ -14,6 +14,27 @@ public function __construct()
         parent::__construct(self::$defaultName);
     }
 
+    public function generate(string $source) : string
+    {
+        $beans = $this->getBeans($source);
+        $sorter = new \CoolBeans\Utils\TableSorter($beans);
+
+        $sortedBeans = $sorter->sort();
+
+        $ddl = '';
+        $lastBean = \array_key_last($sortedBeans);
+
+        foreach ($sortedBeans as $key => $bean) {
+            $ddl .= $this->generateBean($bean);
+
+            if ($lastBean !== $key) {
+                $ddl .= \PHP_EOL . \PHP_EOL;
+            }
+        }
+
+        return $ddl;
+    }
+
     protected function configure() : void
     {
         $this->setName(self::$defaultName);
@@ -40,30 +61,16 @@ protected function execute(
         return 0;
     }
 
-    public function generate(string $source) : string
+    private static function hasPrimaryKeyAttribute(\ReflectionClass $bean) : bool
     {
-        $beans = $this->getBeans($source);
-        $sorter = new \CoolBeans\Utils\TableSorter($beans);
-
-        $sortedBeans = $sorter->sort();
-
-        $ddl = '';
-        $lastBean = \array_key_last($sortedBeans);
-
-        foreach ($sortedBeans as $key => $bean) {
-            $ddl .= $this->generateBean($bean);
-
-            if ($lastBean !== $key) {
-                $ddl .= \PHP_EOL . \PHP_EOL;
-            }
-        }
-
-        return $ddl;
+        return \count($bean->getAttributes(\CoolBeans\Attribute\PrimaryKey::class)) > 0
+            && \count($bean->getAttributes(\CoolBeans\Attribute\PrimaryKey::class)[0]->newInstance()->columns) > 0;
     }
 
     private function generateBean(string $className) : string
     {
         $bean = new \ReflectionClass($className);
+        $this->validateBean($bean);
 
         $beanName = \Infinityloop\Utils\CaseConverter::toSnakeCase($bean->getShortName());
         $toReturn = 'CREATE TABLE `' . $beanName . '`(' . \PHP_EOL;
@@ -83,11 +90,11 @@ private function generateBean(string $className) : string
                 'name' => $this->getPropertyName($property),
                 'dataType' => $this->getDataType($property),
                 'notNull' => $this->getNotNull($property),
-                'default' => $this->getDefault($property),
+                'default' => $this->getDefault($property, $bean),
                 'comment' => $this->getComment($property),
             ];
 
-            $foreignKey = $this->getForeignKey($property);
+            $foreignKey = $this->getForeignKey($property, $bean);
             $uniqueConstraint = $this->getUnique($property, $beanName);
 
             if (\is_string($uniqueConstraint)) {
@@ -192,9 +199,17 @@ private function getTableCollation(\ReflectionClass $bean) : string
         return 'COLLATE = `' . $collationAttribute[0]->newInstance()->collation . '`';
     }
 
-    private function getDefault(\ReflectionProperty $property) : string
+    private function getDefault(\ReflectionProperty $property, \ReflectionClass $bean) : string
     {
-        if ($property->getName() === 'id') {
+        $hasPrimaryKeyAttribute = self::hasPrimaryKeyAttribute($bean);
+        $attributeColumns = $hasPrimaryKeyAttribute
+            ? $bean->getAttributes(\CoolBeans\Attribute\PrimaryKey::class)[0]->newInstance()->columns
+            : [];
+
+        if (
+            ($hasPrimaryKeyAttribute && $attributeColumns[0] === $property->getName())
+            || (!$hasPrimaryKeyAttribute && $property->getName() === 'id')
+        ) {
             return ' AUTO_INCREMENT PRIMARY KEY';
         }
 
@@ -450,12 +465,49 @@ private function printSection(array $data) : string
         return ',' . \PHP_EOL . \PHP_EOL . \implode(',' . \PHP_EOL, $data);
     }
 
-    private function getForeignKey(\ReflectionProperty $property) : ?string
+    private function validateBean(\ReflectionClass $bean) : void
+    {
+        $hasPrimaryKeyAttribute = self::hasPrimaryKeyAttribute($bean);
+        $attributeColumns = $hasPrimaryKeyAttribute
+            ? $bean->getAttributes(\CoolBeans\Attribute\PrimaryKey::class)[0]->newInstance()->columns
+            : [];
+        $hasId = false;
+
+        foreach ($bean->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) {
+            if ($property->getName() === 'id') {
+                $hasId = true;
+            }
+
+            foreach ($attributeColumns as $key => $column) {
+                if ($column === $property->getName()) {
+                    $hasId = true;
+                    unset($attributeColumns[$key]);
+                }
+            }
+        }
+
+        if ($hasPrimaryKeyAttribute && \count($attributeColumns) > 0) {
+            throw new \CoolBeans\Exception\PrimaryKeyColumnDoesntExist(
+                'PrimaryKey attribute column(s) ' . \implode(', ', $attributeColumns) . ' doesn\'t exist in Bean ' . $bean->getShortName() . '.',
+            );
+        }
+
+        if (!$hasPrimaryKeyAttribute && !$hasId) {
+            throw new \CoolBeans\Exception\MissingPrimaryKey('Bean ' . $bean->getShortName() . ' has no primary key.');
+        }
+    }
+
+    private function getForeignKey(\ReflectionProperty $property, \ReflectionClass $bean) : ?string
     {
         $type = $property->getType();
         \assert($type instanceof \ReflectionNamedType);
 
-        if ($type->getName() !== \CoolBeans\PrimaryKey\IntPrimaryKey::class || $property->getName() === 'id') {
+        $hasPrimaryKeyAttribute = self::hasPrimaryKeyAttribute($bean);
+        $attributeColumns = $hasPrimaryKeyAttribute
+            ? $bean->getAttributes(\CoolBeans\Attribute\PrimaryKey::class)[0]->newInstance()->columns
+            : [];
+
+        if ($property->getName() === 'id' || ($this->hasPrimaryKeyAttribute($bean) && \in_array($property->getName(), $attributeColumns, true))) {
             return null;
         }
 
@@ -484,9 +536,11 @@ private function getForeignKey(\ReflectionProperty $property) : ?string
 
             $table = $foreignKey->table;
             $column = $foreignKey->column;
-        } else {
+        } elseif (\str_contains($property->getName(), '_id')) {
             $table = \str_replace('_id', '', $property->getName());
             $column = 'id';
+        } else {
+            return null;
         }
 
         return self::INDENTATION . 'FOREIGN KEY (`' . $property->getName() . '`) REFERENCES `' . $table . '`(`' . $column . '`)'

src/Exception/BeanHasNoPrimaryKey.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Exception;
+
+final class BeanHasNoPrimaryKey extends \Exception
+{
+}

src/Exception/PrimaryKeyColumnDoesntExist.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Exception;
+
+final class PrimaryKeyColumnDoesntExist extends \Exception
+{
+}

src/Exception/PrimaryKeyMultipleColumnsNotImplemented.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Exception;
+
+final class PrimaryKeyMultipleColumnsNotImplemented extends \Exception
+{
+}

src/Utils/TableSorter.php

@@ -69,12 +69,12 @@ private function getForeignKeyTables(\ReflectionClass $bean) : array
             $type = $property->getType();
             \assert($type instanceof \ReflectionNamedType);
 
-            if ($type->getName() !== \CoolBeans\PrimaryKey\IntPrimaryKey::class || !\str_ends_with($property->getName(), '_id')) {
+            $foreignKeyTarget = $this->getForeignKeyDependency($property);
+
+            if ($foreignKeyTarget === null) {
                 continue;
             }
 
-            $foreignKeyTarget = $this->getForeignKeyDependency($property);
-
             if ($foreignKeyTarget === \Infinityloop\Utils\CaseConverter::toSnakeCase($bean->getShortName())) {
                 continue; // self dependency
             }
@@ -85,7 +85,7 @@ private function getForeignKeyTables(\ReflectionClass $bean) : array
         return $toReturn;
     }
 
-    private function getForeignKeyDependency(\ReflectionProperty $property) : string
+    private function getForeignKeyDependency(\ReflectionProperty $property) : ?string
     {
         $foreignKeyAttribute = $property->getAttributes(\CoolBeans\Attribute\ForeignKey::class);
 
@@ -95,6 +95,10 @@ private function getForeignKeyDependency(\ReflectionProperty $property) : string
             return $foreignKey->table;
         }
 
+        if (!\str_ends_with($property->getName(), '_id')) {
+            return null;
+        }
+
         return \substr($property->getName(), 0, -3);
     }
 }

tests/Unit/BeanTest.php

@@ -58,9 +58,8 @@ public function testGetPrimaryKey() : void
     public function testGetIterator() : void
     {
         $iteratorInstance = new class implements \Iterator {
-            public function rewind() : bool
+            public function rewind() : void
             {
-                return false;
             }
 
             public function current() : bool
@@ -73,9 +72,8 @@ public function key() : bool
                 return false;
             }
 
-            public function next() : bool
+            public function next() : void
             {
-                return false;
             }
 
             public function valid() : bool

tests/Unit/Command/SqlGeneratorCommandTest.php

@@ -81,6 +81,8 @@ public function testSimple() : void
             `col8`             DOUBLE(16, 2)    NOT NULL,
             `col9_id`          INT(11) UNSIGNED NOT NULL,
             `col10_id`         INT(11) UNSIGNED NOT NULL,
+            `code`             VARCHAR(255)     NOT NULL AUTO_INCREMENT PRIMARY KEY,
+            `id`               INT(11) UNSIGNED NOT NULL,
 
             INDEX `attribute_bean_col5_index` (`col5`),
             INDEX `attribute_bean_col6_index` (`col6` ASC),
@@ -188,20 +190,54 @@ public function testUndefinedProperty() : void
         ]);
     }
 
-    public function testColumnCount() : void
+    public function testMissingPrimaryKey() : void
     {
         $application = new \Symfony\Component\Console\Application();
         $application->addCommands([new \CoolBeans\Command\SqlGeneratorCommand()]);
 
         $command = $application->find('sqlGenerator');
         $commandTester = new \Symfony\Component\Console\Tester\CommandTester($command);
 
-        $this->expectException(\CoolBeans\Exception\InvalidClassUniqueConstraintColumnCount::class);
-        $this->expectExceptionMessage('ClassUniqueConstraint expects at least two column names.');
+        $this->expectException(\CoolBeans\Exception\MissingPrimaryKey::class);
+        $this->expectExceptionMessage('Bean InvalidBean has no primary key.');
 
         $commandTester->execute([
             'command' => 'sqlGenerator',
-            'source' => __DIR__ . '/../InvalidBean/ColumnCount/',
+            'source' => __DIR__ . '/../InvalidBean/MissingPrimaryKey/',
+        ]);
+    }
+
+    public function testPrimaryKeyAttributeMultipleColumns() : void
+    {
+        $application = new \Symfony\Component\Console\Application();
+        $application->addCommands([new \CoolBeans\Command\SqlGeneratorCommand()]);
+
+        $command = $application->find('sqlGenerator');
+        $commandTester = new \Symfony\Component\Console\Tester\CommandTester($command);
+
+        $this->expectException(\CoolBeans\Exception\PrimaryKeyMultipleColumnsNotImplemented::class);
+        $this->expectExceptionMessage('Multiple column PrimaryKey is not implemented yet.');
+
+        $commandTester->execute([
+            'command' => 'sqlGenerator',
+            'source' => __DIR__ . '/../InvalidBean/PrimaryKeyAttributeMultipleColumns/',
+        ]);
+    }
+
+    public function testPrimaryKeyAttributeMissingColumn() : void
+    {
+        $application = new \Symfony\Component\Console\Application();
+        $application->addCommands([new \CoolBeans\Command\SqlGeneratorCommand()]);
+
+        $command = $application->find('sqlGenerator');
+        $commandTester = new \Symfony\Component\Console\Tester\CommandTester($command);
+
+        $this->expectException(\CoolBeans\Exception\PrimaryKeyColumnDoesntExist::class);
+        $this->expectExceptionMessage('PrimaryKey attribute column(s) unknown doesn\'t exist in Bean InvalidBean.');
+
+        $commandTester->execute([
+            'command' => 'sqlGenerator',
+            'source' => __DIR__ . '/../InvalidBean/PrimaryKeyAttributeMissingColumn/',
         ]);
     }
 }

tests/Unit/InvalidBean/MissingPrimaryKey/InvalidBean.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Tests\Unit\InvalidBean\MissingPrimaryKey;
+
+//@phpcs:disable SlevomatCodingStandard.Classes.ClassStructure.IncorrectGroupOrder
+//@phpcs:disable SlevomatCodingStandard.Classes.UnusedPrivateElements.UnusedProperty
+final class InvalidBean extends \CoolBeans\Bean
+{
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $abc;
+    public int $code;
+}

tests/Unit/InvalidBean/PrimaryKeyAttributeMissingColumn/InvalidBean.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Tests\Unit\InvalidBean\PrimaryKeyAttributeMissingColumn;
+
+//@phpcs:disable SlevomatCodingStandard.Classes.ClassStructure.IncorrectGroupOrder
+//@phpcs:disable SlevomatCodingStandard.Classes.UnusedPrivateElements.UnusedProperty
+#[\CoolBeans\Attribute\PrimaryKey('unknown')]
+final class InvalidBean extends \CoolBeans\Bean
+{
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $id;
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $code;
+}

tests/Unit/InvalidBean/PrimaryKeyAttributeMultipleColumns/InvalidBean.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace CoolBeans\Tests\Unit\InvalidBean\PrimaryKeyAttributeMultipleColumns;
+
+//@phpcs:disable SlevomatCodingStandard.Classes.ClassStructure.IncorrectGroupOrder
+//@phpcs:disable SlevomatCodingStandard.Classes.UnusedPrivateElements.UnusedProperty
+#[\CoolBeans\Attribute\PrimaryKey('id', 'code')]
+final class InvalidBean extends \CoolBeans\Bean
+{
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $id;
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $code;
+}

tests/Unit/TestBean/AttributeBean.php

@@ -16,6 +16,7 @@
 #[\CoolBeans\Attribute\ClassUniqueConstraint(['col4', 'col5', 'col6'])]
 #[\CoolBeans\Attribute\ClassIndex(['col4', 'col5', 'col6'], [null, Order::DESC, Order::ASC])]
 #[\CoolBeans\Attribute\Comment('Some random comment')]
+#[\CoolBeans\Attribute\PrimaryKey('code')]
 final class AttributeBean extends \CoolBeans\Bean
 {
     #[\CoolBeans\Attribute\DefaultValue(DefaultFunction::NOW)]
@@ -50,4 +51,6 @@ final class AttributeBean extends \CoolBeans\Bean
     #[\CoolBeans\Attribute\ForeignKey('simple_bean_2')]
     #[\CoolBeans\Attribute\ForeignKeyConstraint(ForeignKeyConstraintType::RESTRICT, ForeignKeyConstraintType::RESTRICT)]
     public \CoolBeans\PrimaryKey\IntPrimaryKey $col10_id;
+    public string $code;
+    public \CoolBeans\PrimaryKey\IntPrimaryKey $id;
 }