Move some interfaces aaround

spatie · Sep 10, 2024 · f87b25a · f87b25a
1 parent 1732519
commit f87b25a
Show file tree

Hide file tree

Showing 15 changed files with 31 additions and 27 deletions.
diff --git a/src/Concerns/TransformableData.php b/src/Concerns/TransformableData.php
@@ -5,6 +5,7 @@
 use Exception;
 use Spatie\LaravelData\Contracts\BaseData as BaseDataContract;
 use Spatie\LaravelData\Contracts\BaseDataCollectable as BaseDataCollectableContract;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\IncludeableData as IncludeableDataContract;
 use Spatie\LaravelData\Support\DataContainer;
 use Spatie\LaravelData\Support\EloquentCasts\DataEloquentCast;
@@ -31,7 +32,7 @@ public function transform(
             default => throw new Exception('Cannot transform data object')
         };
 
-        if ($this instanceof IncludeableDataContract) {
+        if ($this instanceof IncludeableDataContract && $this instanceof ContextableDataContract) {
             $transformationContext->mergePartialsFromDataContext($this);
         }
 

diff --git a/src/Contracts/IncludeableData.php b/src/Contracts/IncludeableData.php
@@ -4,7 +4,7 @@
 
 use Closure;
 
-interface IncludeableData extends ContextableData
+interface IncludeableData
 {
     public function include(string ...$includes): object;
 

diff --git a/src/Contracts/ResponsableData.php b/src/Contracts/ResponsableData.php
@@ -4,7 +4,7 @@
 
 use Illuminate\Contracts\Support\Responsable;
 
-interface ResponsableData extends TransformableData, Responsable
+interface ResponsableData extends Responsable
 {
     /**
      * @param \Illuminate\Http\Request $request

diff --git a/src/Contracts/TransformableData.php b/src/Contracts/TransformableData.php
@@ -9,7 +9,7 @@
 use Spatie\LaravelData\Support\Transformation\TransformationContext;
 use Spatie\LaravelData\Support\Transformation\TransformationContextFactory;
 
-interface TransformableData extends JsonSerializable, Jsonable, Arrayable, EloquentCastable, ContextableData
+interface TransformableData extends JsonSerializable, Jsonable, Arrayable, EloquentCastable
 {
     public function transform(
         null|TransformationContextFactory|TransformationContext $transformationContext = null,

diff --git a/src/Contracts/WrappableData.php b/src/Contracts/WrappableData.php
@@ -4,7 +4,7 @@
 
 use Spatie\LaravelData\Support\Wrapping\Wrap;
 
-interface WrappableData extends ContextableData
+interface WrappableData
 {
     public function withoutWrapping();
 

diff --git a/src/CursorPaginatedDataCollection.php b/src/CursorPaginatedDataCollection.php
@@ -14,6 +14,7 @@
 use Spatie\LaravelData\Concerns\TransformableData;
 use Spatie\LaravelData\Concerns\WrappableData;
 use Spatie\LaravelData\Contracts\BaseDataCollectable as BaseDataCollectableContract;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\IncludeableData as IncludeableDataContract;
 use Spatie\LaravelData\Contracts\ResponsableData as ResponsableDataContract;
 use Spatie\LaravelData\Contracts\TransformableData as TransformableDataContract;
@@ -28,7 +29,7 @@
  *
  * @implements  IteratorAggregate<TKey, TValue>
  */
-class CursorPaginatedDataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, IteratorAggregate, Countable
+class CursorPaginatedDataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ContextableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, IteratorAggregate, Countable
 {
     use ResponsableData;
     use IncludeableData;

diff --git a/src/Data.php b/src/Data.php
@@ -14,14 +14,15 @@
 use Spatie\LaravelData\Concerns\WrappableData;
 use Spatie\LaravelData\Contracts\AppendableData as AppendableDataContract;
 use Spatie\LaravelData\Contracts\BaseData as BaseDataContract;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\EmptyData as EmptyDataContract;
 use Spatie\LaravelData\Contracts\IncludeableData as IncludeableDataContract;
 use Spatie\LaravelData\Contracts\ResponsableData as ResponsableDataContract;
 use Spatie\LaravelData\Contracts\TransformableData as TransformableDataContract;
 use Spatie\LaravelData\Contracts\ValidateableData as ValidateableDataContract;
 use Spatie\LaravelData\Contracts\WrappableData as WrappableDataContract;
 
-abstract class Data implements Responsable, AppendableDataContract, BaseDataContract, TransformableDataContract, IncludeableDataContract, ResponsableDataContract, ValidateableDataContract, WrappableDataContract, EmptyDataContract
+abstract class Data implements Responsable, AppendableDataContract, BaseDataContract, TransformableDataContract, ContextableDataContract, IncludeableDataContract, ResponsableDataContract, ValidateableDataContract, WrappableDataContract, EmptyDataContract
 {
     use ResponsableData;
     use IncludeableData;

diff --git a/src/DataCollection.php b/src/DataCollection.php
@@ -17,6 +17,7 @@
 use Spatie\LaravelData\Concerns\WrappableData;
 use Spatie\LaravelData\Contracts\BaseData;
 use Spatie\LaravelData\Contracts\BaseDataCollectable as BaseDataCollectableContract;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\IncludeableData as IncludeableDataContract;
 use Spatie\LaravelData\Contracts\ResponsableData as ResponsableDataContract;
 use Spatie\LaravelData\Contracts\TransformableData as TransformableDataContract;
@@ -32,7 +33,7 @@
  * @implements \ArrayAccess<TKey, TValue>
  * @implements  IteratorAggregate<TKey, TValue>
  */
-class DataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, IteratorAggregate, Countable, ArrayAccess
+class DataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, ContextableDataContract, IteratorAggregate, Countable, ArrayAccess
 {
     /** @use \Spatie\LaravelData\Concerns\BaseDataCollectable<TKey, TValue> */
     use BaseDataCollectable;
@@ -112,7 +113,9 @@ public function offsetGet($offset): mixed
 
         $data = $this->items->offsetGet($offset);
 
-        if ($data instanceof IncludeableDataContract) {
+        if ($data instanceof IncludeableDataContract
+            && $data instanceof ContextableDataContract
+        ) {
             $data->getDataContext()->mergePartials($this->getDataContext());
         }
 

diff --git a/src/PaginatedDataCollection.php b/src/PaginatedDataCollection.php
@@ -14,6 +14,7 @@
 use Spatie\LaravelData\Concerns\TransformableData;
 use Spatie\LaravelData\Concerns\WrappableData;
 use Spatie\LaravelData\Contracts\BaseDataCollectable as BaseDataCollectableContract;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\IncludeableData as IncludeableDataContract;
 use Spatie\LaravelData\Contracts\ResponsableData as ResponsableDataContract;
 use Spatie\LaravelData\Contracts\TransformableData as TransformableDataContract;
@@ -28,7 +29,7 @@
  *
  * @implements IteratorAggregate<TKey, TValue>
  */
-class PaginatedDataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, IteratorAggregate, Countable
+class PaginatedDataCollection implements Responsable, BaseDataCollectableContract, TransformableDataContract, ContextableDataContract, ResponsableDataContract, IncludeableDataContract, WrappableDataContract, IteratorAggregate, Countable
 {
     use ResponsableData;
     use IncludeableData;

diff --git a/src/Resolvers/TransformedDataCollectableResolver.php b/src/Resolvers/TransformedDataCollectableResolver.php
@@ -10,6 +10,7 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Enumerable;
 use Spatie\LaravelData\Contracts\BaseData;
+use Spatie\LaravelData\Contracts\ContextableData as ContextableDataContract;
 use Spatie\LaravelData\Contracts\TransformableData;
 use Spatie\LaravelData\Contracts\WrappableData;
 use Spatie\LaravelData\CursorPaginatedDataCollection;
@@ -170,7 +171,10 @@ protected function transformationClosure(
                 return $data;
             }
 
-            if ($nestedContext->transformValues === false && $nestedContext->hasPartials()) {
+            if ($nestedContext->transformValues === false
+                && $nestedContext->hasPartials()
+                && $data instanceof ContextableDataContract
+            ) {
                 $data->getDataContext()->mergeTransformationContext($nestedContext);
 
                 return $data;

diff --git a/src/Support/Partials/Partial.php b/src/Support/Partials/Partial.php
@@ -4,8 +4,7 @@
 
 use Closure;
 use Laravel\SerializableClosure\SerializableClosure;
-use Spatie\LaravelData\Contracts\BaseData;
-use Spatie\LaravelData\Contracts\BaseDataCollectable;
+use Spatie\LaravelData\Contracts\IncludeableData;
 use Spatie\LaravelData\Support\Partials\Segments\AllPartialSegment;
 use Spatie\LaravelData\Support\Partials\Segments\FieldsPartialSegment;
 use Spatie\LaravelData\Support\Partials\Segments\NestedPartialSegment;
@@ -218,7 +217,7 @@ protected function getCurrentSegment(): ?PartialSegment
         return $this->segments[$this->pointer] ?? null;
     }
 
-    public function isRequired(BaseData|BaseDataCollectable $data): bool
+    public function isRequired(IncludeableData $data): bool
     {
         if ($this->condition === null) {
             return true;

diff --git a/src/Support/Transformation/DataContext.php b/src/Support/Transformation/DataContext.php
@@ -2,8 +2,7 @@
 
 namespace Spatie\LaravelData\Support\Transformation;
 
-use Spatie\LaravelData\Contracts\BaseData;
-use Spatie\LaravelData\Contracts\BaseDataCollectable;
+use Spatie\LaravelData\Contracts\IncludeableData;
 use Spatie\LaravelData\Support\DataContainer;
 use Spatie\LaravelData\Support\Partials\PartialsCollection;
 use Spatie\LaravelData\Support\Wrapping\Wrap;
@@ -105,7 +104,7 @@ public function mergeTransformationContext(
     }
 
     public function getRequiredPartialsAndRemoveTemporaryOnes(
-        BaseData|BaseDataCollectable $data,
+        IncludeableData $data,
         PartialsCollection $partials,
     ): PartialsCollection {
         $requiredPartials = new PartialsCollection();

diff --git a/src/Support/Transformation/TransformationContext.php b/src/Support/Transformation/TransformationContext.php
@@ -2,8 +2,7 @@
 
 namespace Spatie\LaravelData\Support\Transformation;
 
-use Spatie\LaravelData\Contracts\BaseData;
-use Spatie\LaravelData\Contracts\BaseDataCollectable;
+use Spatie\LaravelData\Contracts\ContextableData;
 use Spatie\LaravelData\Contracts\IncludeableData;
 use Spatie\LaravelData\Support\Partials\Partial;
 use Spatie\LaravelData\Support\Partials\PartialsCollection;
@@ -144,11 +143,8 @@ public function rollBackPartialsWhenRequired(): void
         }
     }
 
-    /**
-     * @param IncludeableData&(BaseData|BaseDataCollectable) $data
-     */
     public function mergePartialsFromDataContext(
-        IncludeableData $data
+        IncludeableData&ContextableData $data
     ): self {
         $dataContext = $data->getDataContext();
 

diff --git a/src/Support/Transformation/TransformationContextFactory.php b/src/Support/Transformation/TransformationContextFactory.php
@@ -2,8 +2,7 @@
 
 namespace Spatie\LaravelData\Support\Transformation;
 
-use Spatie\LaravelData\Contracts\BaseData;
-use Spatie\LaravelData\Contracts\BaseDataCollectable;
+use Spatie\LaravelData\Contracts\IncludeableData;
 use Spatie\LaravelData\Support\Partials\ForwardsToPartialsDefinition;
 use Spatie\LaravelData\Support\Partials\PartialsCollection;
 use Spatie\LaravelData\Support\Wrapping\WrapExecutionType;
@@ -37,7 +36,7 @@ protected function __construct(
     }
 
     public function get(
-        BaseData|BaseDataCollectable $data,
+        IncludeableData $data,
     ): TransformationContext {
         $includePartials = null;
 

diff --git a/tests/Support/DataReturnTypeTest.php b/tests/Support/DataReturnTypeTest.php
@@ -109,10 +109,10 @@ public function none()
                 Spatie\LaravelData\Contracts\ResponsableData::class,
                 Spatie\LaravelData\Contracts\IncludeableData::class,
                 Spatie\LaravelData\Contracts\WrappableData::class,
+                Spatie\LaravelData\Contracts\ContextableData::class,
                 IteratorAggregate::class,
                 Countable::class,
                 ArrayAccess::class,
-                Spatie\LaravelData\Contracts\ContextableData::class,
                 Illuminate\Contracts\Database\Eloquent\Castable::class,
                 Illuminate\Contracts\Support\Arrayable::class,
                 Illuminate\Contracts\Support\Jsonable::class,