Merge remote-tracking branch 'origin/master'

README.md

@@ -3,3 +3,7 @@
 [![Build Status](https://travis-ci.org/cycle/proxy-factory.svg?branch=master)](https://travis-ci.org/cycle/proxy-factory)
 [![Codecov](https://codecov.io/gh/cycle/proxy-factory/branch/master/graph/badge.svg)](https://codecov.io/gh/cycle/proxy-factory/)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/proxy-factory/badges/quality-score.png)](https://scrutinizer-ci.com/g/cycle/proxy-factory/)
+
+License:
+--------
+The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained by [Spiral Scout](https://spiralscout.com).

src/Declaration/Extractor/Methods.php

@@ -14,7 +14,7 @@
 
 final class Methods
 {
-    private const MAGIC_METHOD_NAMES = [
+    private const MAGIC_METHODS = [
         '__construct',
         '__destruct',
         '__call',
@@ -31,6 +31,8 @@ final class Methods
         '__debugInfo',
     ];
 
+    private const RESERVED_UNQUALIFIED_RETURN_TYPES = ['self', 'static', 'object'];
+
     /**
      * @param \ReflectionClass $reflection
      * @return array
@@ -70,7 +72,7 @@ private function isIgnoredMethod(\ReflectionMethod $method): bool
      */
     private function isMagicMethod(string $name): bool
     {
-        return in_array($name, self::MAGIC_METHOD_NAMES, true);
+        return in_array($name, self::MAGIC_METHODS, true);
     }
 
     /**
@@ -108,8 +110,9 @@ private function defineReturnType(\ReflectionMethod $method): ?Node
         }
 
         $name = $returnType->getName();
+        $name = $this->replacedSelfReturnTypeName($method, $name);
 
-        if (!$returnType->isBuiltin()) {
+        if ($this->returnTypeShouldBeQualified($returnType, $name)) {
             $name = '\\' . $name;
         }
 
@@ -120,6 +123,30 @@ private function defineReturnType(\ReflectionMethod $method): ?Node
         return new Node\Identifier($name);
     }
 
+    /**
+     * @param \ReflectionMethod $method
+     * @param string            $name
+     * @return string
+     */
+    private function replacedSelfReturnTypeName(\ReflectionMethod $method, string $name): string
+    {
+        return $name === 'self' ? $method->class : $name;
+    }
+
+    /**
+     * @param \ReflectionType $returnType
+     * @param string          $name
+     * @return bool
+     */
+    private function returnTypeShouldBeQualified(\ReflectionType $returnType, string $name): bool
+    {
+        if (in_array($name, self::RESERVED_UNQUALIFIED_RETURN_TYPES, true)) {
+            return false;
+        }
+
+        return !$returnType->isBuiltin();
+    }
+
     /**
      * @param \ReflectionMethod $method
      * @return array

tests/Promise/Declaration/ExtractorTest.php

@@ -8,6 +8,7 @@
 use Cycle\ORM\Promise\Tests\Declaration\Fixtures\Entity;
 use Cycle\ORM\Promise\Tests\Declaration\Fixtures\EntityWithConstructor;
 use Cycle\ORM\Promise\Tests\Fixtures\ChildEntity;
+use Cycle\ORM\Promise\Tests\Fixtures\ParentEntity;
 use PHPUnit\Framework\TestCase;
 use Spiral\Core\Container;
 
@@ -47,6 +48,18 @@ public function testExtractMethods(): void
         $this->assertSame(['public', 'protected'], $this->getDeclaration(EntityWithConstructor::class)->properties);
     }
 
+    public function testSelfReturnTypes(): void
+    {
+        $extracted = [];
+        foreach ($this->getDeclaration(ChildEntity::class)->methods as $method) {
+            $extracted[$method->name->name] = $method->returnType->name;
+        }
+
+        $this->assertNotContains('self', $extracted);
+        $this->assertContains('\\' . ChildEntity::class, $extracted);
+        $this->assertContains('\\' . ParentEntity::class, $extracted);
+    }
+
     private function getDeclaration(string $class): Structure
     {
         return $this->extractor()->extract(new \ReflectionClass($class));

tests/Promise/FactoryTest.php

@@ -69,15 +69,19 @@ private function filesDirectory(): string
     public function testPromise(string $materializer, array $params): void
     {
         $role = SchematicEntity::class;
-        $this->orm()->make($role, ['id' => 1, 'name' => 'my name']);
-        $this->orm()->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
+        $orm = $this->orm();
+        $orm->make($role, ['id' => 1, 'name' => 'my name']);
+        $orm->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
+
+        $tr = new Transaction($orm);
+        $tr->run();
 
         $scope = ['id' => 2];
 
         $this->bindMaterializer($this->container->make($materializer, $params));
 
         /** @var SchematicEntity|\Cycle\ORM\Promise\Resolver $promise */
-        $promise = $this->factory()->promise($this->orm(), $role, $scope);
+        $promise = $this->factory()->promise($orm, $role, $scope);
 
         $this->assertInstanceOf($role, $promise);
         $this->assertNotNull($promise->__resolve());
@@ -89,12 +93,12 @@ public function testPromise(string $materializer, array $params): void
 
         $promise->email = 'my second email';
 
-        $tr = new Transaction($this->orm());
+        $tr = new Transaction($orm);
         $tr->persist($promise);
         $tr->run();
 
         /** @var SchematicEntity $o */
-        $o = $this->orm()->get($role, ['id' => 2]);
+        $o = $orm->get($role, ['id' => 2]);
         $this->assertEquals('my third name', $o->getName());
         $this->assertEquals('my second email', $o->email);
 
@@ -116,15 +120,16 @@ public function testPromise(string $materializer, array $params): void
     public function testNullScope(string $materializer, array $params): void
     {
         $role = SchematicEntity::class;
-        $this->orm()->make($role, ['id' => 1, 'name' => 'my name']);
-        $this->orm()->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
+        $orm = $this->orm();
+        $orm->make($role, ['id' => 1, 'name' => 'my name']);
+        $orm->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
 
         $scope = [];
 
         $this->bindMaterializer($this->container->make($materializer, $params));
 
         /** @var SchematicEntity|\Cycle\ORM\Promise\PromiseInterface $promise */
-        $promise = $this->factory()->promise($this->orm(), $role, $scope);
+        $promise = $this->factory()->promise($orm, $role, $scope);
 
         $this->assertInstanceOf($role, $promise);
         $this->assertNull($promise->__resolve());
@@ -145,15 +150,16 @@ public function testNullScope(string $materializer, array $params): void
     public function testUnknownScope(string $materializer, array $params): void
     {
         $role = SchematicEntity::class;
-        $this->orm()->make($role, ['id' => 1, 'name' => 'my name']);
-        $this->orm()->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
+        $orm = $this->orm();
+        $orm->make($role, ['id' => 1, 'name' => 'my name']);
+        $orm->make($role, ['id' => 2, 'name' => 'my second name', 'email' => 'my email']);
 
         $scope = ['id' => 3];
 
         $this->bindMaterializer($this->container->make($materializer, $params));
 
         /** @var SchematicEntity|\Cycle\ORM\Promise\PromiseInterface $promise */
-        $promise = $this->factory()->promise($this->orm(), $role, $scope);
+        $promise = $this->factory()->promise($orm, $role, $scope);
 
         $this->assertInstanceOf($role, $promise);
         $this->assertNull($promise->__resolve());

tests/Promise/Fixtures/ChildEntity.php

@@ -15,6 +15,11 @@ public function childProp(): string
         return 'childPropValue';
     }
 
+    public function childSelf(): self
+    {
+        return $this;
+    }
+
     protected function childProtectedProp(): \stdClass
     {
         return new \stdClass();

tests/Promise/Fixtures/ParentEntity.php

@@ -17,4 +17,9 @@ protected function parentProtectedProp(): string
     {
         return 'childParentPropValue';
     }
+
+    public function parentSelf(): self
+    {
+        return $this;
+    }
 }