add: support for dot notations in DataObject Relations (#14) (#21)

* feat: add support for dot notations in DataObject Relations (#14)

* feat: add support for dot notations in DataObject Relations

* feat: add tests for relationships

---------

Co-authored-by: Andrea Sciutto <andrea@archipro.co.nz>

* nolog: fix config

---------

Co-authored-by: saas-archipro <124836169+saas-archipro@users.noreply.github.com>
Co-authored-by: Andrea Sciutto <andrea@archipro.co.nz>

Author: 3 people

src/Reflection/MethodClassReflectionExtension.php

@@ -147,8 +147,12 @@ private function createMethods(ClassReflection $classReflection): array
                         }
                     }
                     // Ignore parameters
-                    $type = explode('(', $type, 2);
-                    $type = $type[0];
+                    $type = explode('(', $type, 2)[0];
+
+                    // Ignore dot notation such as 'MyClass::class.MyField'
+                    $type = explode('.', $type, 2)[0];
+
+
                     $componentMethodClass = new $componentClass($methodName, $classReflection, new ObjectType($type));
                     $methods[strtolower($methodName)] = $componentMethodClass;
                 }

tests/Reflection/MethodClassReflectionExtensionTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Syntro\SilverstripePHPStan\Tests\Reflection;
+
+use MethodClassReflectionReturnTypesNamespace\Team;
+use PHPStan\Testing\TypeInferenceTestCase;
+use SilverStripe\Core\Config\Config;
+
+class MethodClassReflectionExtensionTest  extends TypeInferenceTestCase
+{
+    /**
+     * @return iterable<mixed>
+     */
+    public function dataFileAsserts(): iterable
+    {
+        // path to a file with actual asserts of expected types:
+        require_once(__DIR__ . '/data/method-class-reflection.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/method-class-reflection.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     */
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        ...$args
+    ): void {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+
+    public static function getAdditionalConfigFiles(): array
+    {
+        // path to your project's phpstan.neon, or extension.neon in case of custom extension packages
+        return [
+            __DIR__ . '/../../phpstan.neon'
+        ];
+    }
+}

tests/Reflection/data/method-class-reflection.php

@@ -0,0 +1,73 @@
+<?php
+// @codingStandardsIgnoreStart
+namespace MethodClassReflectionReturnTypesNamespace;
+
+// SilverStripe
+use SilverStripe\Core\Config\Config;
+use SilverStripe\ORM\DataObject;
+use Syntro\SilverstripePHPStan\ClassHelper;
+use function PHPStan\Testing\assertType;
+
+/**
+ * setting up relations in the Classes doesn't get picked up
+ * Need to add to the config manually
+ * @return void
+ */
+function initDbRelations() {
+    Config::modify()->merge(Team::class, 'has_many', [
+        'Players' => Player::class,
+        'WinningPlayers' => Player::class . '.WinningTeam'
+    ]);
+
+    Config::modify()->merge(Player::class, 'has_one', [
+        'Team' => Team::class,
+        'WinningTeam' => Team::class . '.WinningPlayers'
+    ]);
+
+    Config::modify()->merge(Coach::class, 'belongs_to', [
+        'Team' => Team::class,
+        'WinningTeam' => Team::class . '.WinningCoach',
+    ]);
+}
+
+initDbRelations();
+
+class Foo
+{
+    public function doFoo(): void
+    {
+
+
+        $player = new Player;
+        // Standard has_one
+        assertType(Team::class, $player->Team());
+        // Has one with a custom relation name
+        assertType(Team::class, $player->WinningTeam());
+
+        $team = new Team();
+        // Standard has_one
+        assertType( sprintf('%s<%s>', ClassHelper::HasManyList, Player::class), $team->Players());
+        // Has one with a custom relation name
+        assertType( sprintf('%s<%s>', ClassHelper::HasManyList, Player::class), $team->WinningPlayers());
+
+        $coach = new Coach();
+        assertType(Team::class, $coach->Team());
+        // Has one with a custom relation name
+        assertType(Team::class, $coach->WinningTeam());
+        die();
+    }
+}
+
+class Team extends DataObject
+{
+
+}
+
+class Player extends DataObject
+{
+}
+
+class Coach extends DataObject
+{
+}
+// @codingStandardsIgnoreEnd