[MINOR BC BREAK] Syncing: PivotWithRelation -> PivotWithCentralResource

The old names of the class and method were misleading. We don't
actually need any relation. And we don't even need a model instance
as we were returning previously -- the only use of that method was
in TriggerSyncingEvents which would immediately use ::class on the
returned value. Therefore, all we are asking for in this interface
is just the central resource class.

assets/TenancyServiceProvider.stub.php

@@ -146,7 +146,9 @@ class TenancyServiceProvider extends ServiceProvider
             ResourceSyncing\Events\CentralResourceDetachedFromTenant::class => [
                 ResourceSyncing\Listeners\DeleteResourceInTenant::class,
             ],
-            // Fired only when a synced resource is changed in a different DB than the origin DB (to avoid infinite loops)
+
+            // Fired only when a synced resource is changed (as a result of syncing)
+            // in a different DB than DB from which the change originates (to avoid infinite loops)
             ResourceSyncing\Events\SyncedResourceSavedInForeignDatabase::class => [],
 
             // Storage symlinks

src/ResourceSyncing/CentralResourceNotAvailableInPivotException.php

@@ -13,7 +13,7 @@ class CentralResourceNotAvailableInPivotException extends Exception
         parent::__construct(
             'Central resource is not accessible in pivot model.
             To attach a resource to a tenant, use $centralResource->tenants()->attach($tenant) instead of $tenant->resources()->attach($centralResource) (same for detaching).
-            To make this work both ways, you can make your pivot implement PivotWithRelation and return the related model in getRelatedModel() or extend MorphPivot.'
+            To make this work both ways, you can make your pivot implement PivotWithCentralResource and return the related model in getCentralResourceClass() or extend MorphPivot.'
         );
     }
 }

src/ResourceSyncing/PivotWithCentralResource.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\ResourceSyncing;
+
+interface PivotWithCentralResource
+{
+    /** @return class-string<\Illuminate\Database\Eloquent\Model&Syncable> */
+    public function getCentralResourceClass(): string;
+}

src/ResourceSyncing/PivotWithRelation.php

@@ -1,15 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Stancl\Tenancy\ResourceSyncing;
-
-use Illuminate\Database\Eloquent\Model;
-
-interface PivotWithRelation
-{
-    /**
-     * E.g. return $this->users()->getModel().
-     */
-    public function getRelatedModel(): Model;
-}

src/ResourceSyncing/TriggerSyncingEvents.php

@@ -79,9 +79,9 @@ trait TriggerSyncingEvents
      */
     protected function getResourceClass(): string
     {
-        /** @var $this&(Pivot|MorphPivot|((Pivot|MorphPivot)&PivotWithRelation)) $this */
+        /** @var $this&(Pivot|MorphPivot|((Pivot|MorphPivot)&PivotWithCentralResource)) $this */
-        if ($this instanceof PivotWithRelation) {
+        if ($this instanceof PivotWithCentralResource) {
-            return $this->getRelatedModel()::class;
+            return $this->getCentralResourceClass();
         }
 
         if ($this instanceof MorphPivot) {

tests/Etc/ResourceSyncing/CustomPivot.php

@@ -4,20 +4,13 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Tests\Etc\ResourceSyncing;
 
-use Illuminate\Database\Eloquent\Model;
+use Stancl\Tenancy\ResourceSyncing\PivotWithCentralResource;
-use Illuminate\Database\Eloquent\Relations\BelongsToMany;
-use Stancl\Tenancy\ResourceSyncing\PivotWithRelation;
 use Stancl\Tenancy\ResourceSyncing\TenantPivot;
 
-class CustomPivot extends TenantPivot implements PivotWithRelation
+class CustomPivot extends TenantPivot implements PivotWithCentralResource
 {
-    public function users(): BelongsToMany
+    public function getCentralResourceClass(): string
     {
-        return $this->belongsToMany(CentralUser::class);
+        return CentralUser::class;
-    }
-
-    public function getRelatedModel(): Model
-    {
-        return $this->users()->getModel();
     }
 }

tests/ResourceSyncingTest.php

@@ -263,7 +263,7 @@ test('attaching central resources to tenants or vice versa creates synced tenant
         expect(TenantUser::all())->toHaveCount(0);
     });
 
-    // Attaching resources to tenants requires using a pivot that implements the PivotWithRelation interface
+    // Attaching resources to tenants requires using a pivot that implements the PivotWithCentralResource interface
     $tenant->customPivotUsers()->attach($createCentralUser());
     $createCentralUser()->tenants()->attach($tenant);
 
@@ -287,7 +287,7 @@ test('detaching central users from tenants or vice versa force deletes the synce
     migrateUsersTableForTenants();
 
     if ($attachUserToTenant) {
-        // Attaching resources to tenants requires using a pivot that implements the PivotWithRelation interface
+        // Attaching resources to tenants requires using a pivot that implements the PivotWithCentralResource interface
         $tenant->customPivotUsers()->attach($centralUser);
     } else {
         $centralUser->tenants()->attach($tenant);
@@ -298,7 +298,7 @@ test('detaching central users from tenants or vice versa force deletes the synce
     });
 
     if ($attachUserToTenant) {
-        // Detaching resources from tenants requires using a pivot that implements the PivotWithRelation interface
+        // Detaching resources from tenants requires using a pivot that implements the PivotWithCentralResource interface
         $tenant->customPivotUsers()->detach($centralUser);
     } else {
         $centralUser->tenants()->detach($tenant);
@@ -333,7 +333,7 @@ test('detaching central users from tenants or vice versa force deletes the synce
     });
 
     if ($attachUserToTenant) {
-        // Detaching resources from tenants requires using a pivot that implements the PivotWithRelation interface
+        // Detaching resources from tenants requires using a pivot that implements the PivotWithCentralResource interface
         $tenant->customPivotUsers()->detach($centralUserWithSoftDeletes);
     } else {
         $centralUserWithSoftDeletes->tenants()->detach($tenant);