Merge pull request #75: Use schema modifiers as mutable

composer.json

@@ -22,6 +22,11 @@
       "Cycle\\Schema\\": "src/"
     }
   },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "2.9.x-dev"
+    }
+  },
   "autoload-dev": {
     "psr-4": {
       "Cycle\\Schema\\Tests\\": "tests/Schema/"

src/Compiler.php

@@ -123,6 +123,7 @@ private function compute(Registry $registry, Entity $entity): void
 
         // Apply modifiers
         foreach ($entity->getSchemaModifiers() as $modifier) {
+            \assert($modifier instanceof SchemaModifierInterface);
             try {
                 $modifier->modifySchema($schema);
             } catch (Throwable $e) {

src/Definition/Entity.php

@@ -252,7 +252,10 @@ public function getForeignKeys(): ForeignKeyMap
 
     public function addSchemaModifier(SchemaModifierInterface $modifier): self
     {
-        $this->schemaModifiers[] = $modifier;
+        $this->schemaModifiers[] = $modifier->withRole($this->role ?? throw new EntityException(
+            'Entity must have a `role` to be able to add a modifier.'
+        ));
+
         return $this;
     }
 
@@ -261,7 +264,6 @@ public function addSchemaModifier(SchemaModifierInterface $modifier): self
      */
     public function getSchemaModifiers(): \Traversable
     {
-        // yield from $this->getRelations();
         yield from $this->schemaModifiers;
     }
 

src/Generator/GenerateModifiers.php

@@ -32,7 +32,7 @@ protected function register(Registry $registry, Entity $entity): void
         foreach ($entity->getSchemaModifiers() as $modifier) {
             \assert($modifier instanceof SchemaModifierInterface);
             try {
-                $modifier->withRole($role)->compute($registry);
+                $modifier->compute($registry);
             } catch (SchemaModifierException $e) {
                 throw new SchemaException(
                     sprintf('Unable to compute modifier `%s` for the `%s` role.', $modifier::class, $role),

src/Generator/RenderModifiers.php

@@ -32,7 +32,7 @@ protected function register(Registry $registry, Entity $entity): void
         foreach ($entity->getSchemaModifiers() as $modifier) {
             \assert($modifier instanceof SchemaModifierInterface);
             try {
-                $modifier->withRole($role)->render($registry);
+                $modifier->render($registry);
             } catch (SchemaModifierException $e) {
                 throw new SchemaException(
                     sprintf('Unable to render modifier `%s` for the `%s` role.', $modifier::class, $role),

tests/Schema/EntityTest.php

@@ -303,14 +303,29 @@ public function testJoinedTableInheritance(): void
         $this->assertSame($inheritance, $e->getInheritance());
     }
 
-    public function testSchemaModifier(): void
+    public function testSchemaModifierWithRole(): void
     {
+        $modifier = $this->createMock(SchemaModifierInterface::class);
+        $modifier->expects($this->once())->method('withRole')->with('my-entity')->willReturnSelf();
+
         $e = new Entity();
-        $e->addSchemaModifier($modifier = $this->createMock(SchemaModifierInterface::class));
+        $e->setRole('my-entity');
+        $e->addSchemaModifier($modifier);
 
         $this->assertSame([$modifier], iterator_to_array($e->getSchemaModifiers()));
     }
 
+    public function testSchemaModifier(): void
+    {
+        $modifier = $this->createMock(SchemaModifierInterface::class);
+        $e = new Entity();
+
+        $this->expectException(EntityException::class);
+        $this->expectExceptionMessage('Entity must have a `role` to be able to add a modifier.');
+
+        $e->addSchemaModifier($modifier);
+    }
+
     public function testMergeTwoEntities(): void
     {
         $e = new Entity();

tests/Schema/Generator/GenerateModifiersTest.php

@@ -98,7 +98,6 @@ public function testErrorInsideModifierShouldThrowAnException(string $method)
     public function brokenMethodsDataProvider()
     {
         return [
-            'withRole' => ['withRole'],
             'compute' => ['compute'],
         ];
     }

tests/Schema/Generator/RenderModifiersTest.php

@@ -28,12 +28,10 @@ public function testEntityShouldBeRendered()
         $user->setRole('user')->setClass(User::class);
         $user->getFields()->set('foo_bar', (new Field())->setType('primary')->setColumn('id'));
 
-        $user->addSchemaModifier($mock = $this->createMock(SchemaModifierInterface::class));
-        $mock
-            ->expects($this->atLeastOnce())
-            ->method('withRole')
-            ->with($this->equalTo('user'))
-            ->willReturn($mock);
+        $mock = $this->createMock(SchemaModifierInterface::class);
+        $mock->expects(self::once())->method('withRole')->with('user')->willReturnSelf();
+
+        $user->addSchemaModifier($mock);
 
         $mock
             ->expects($this->atLeastOnce())
@@ -73,7 +71,7 @@ public function testErrorInsideModifierShouldThrowAnException(string $method)
     public function brokenMethodsDataProvider()
     {
         return [
-            'withRole' => ['withRole'],
+            // 'withRole' => ['withRole'],
             'render' => ['render'],
         ];
     }

tests/docker-compose.yml

@@ -9,8 +9,8 @@ services:
       SA_PASSWORD: "SSpaSS__1"
       ACCEPT_EULA: "Y"
 
-  mysql_latest:
-    image: mysql:latest
+  mysql:
+    image: mysql:8.0.37
     restart: always
     command: --default-authentication-plugin=mysql_native_password
     ports: