wip

UPGRADING.md

@@ -21,7 +21,7 @@ The following things are required when upgrading:
 - If you have implemented a custom `Transformer`, update the `transform` method signature with the new `TransformationContext` parameter
 - If you have implemented a custom `Cast`
   - The `$castContext` parameter is renamed to `$properties` and changed it type from `array` to  `collection`
-  - A new `$creationContext` parameter is added of type `CreationContext`
+  - A new `$context` parameter is added of type `CreationContext`
 - If you have implemented a custom DataPipe, update the `handle` method signature with the new `TransformationContext` parameter
 - If you manually created `ValidatePropertiesDataPipe` using the `allTypes` parameter, please now use the creation context for this
 - The `withoutMagicalCreationFrom` method was removed from data in favour for creation by factory

src/Attributes/WithCastAndTransformer.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Spatie\LaravelData\Attributes;
+
+use Attribute;
+use Spatie\LaravelData\Casts\Cast;
+use Spatie\LaravelData\Exceptions\CannotCreateCastAttribute;
+use Spatie\LaravelData\Exceptions\CannotCreateTransformerAttribute;
+use Spatie\LaravelData\Transformers\Transformer;
+
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
+class WithCastAndTransformer implements GetsCast
+{
+    public array $arguments;
+
+    public function __construct(
+        /** @var class-string<Transformer&Cast> $class */
+        public string $class,
+        mixed ...$arguments
+    ) {
+        if (! is_a($this->class, Transformer::class, true)) {
+            throw CannotCreateTransformerAttribute::notATransformer();
+        }
+
+        if (! is_a($this->class, Cast::class, true)) {
+            throw CannotCreateCastAttribute::notACast();
+        }
+
+        $this->arguments = $arguments;
+    }
+
+    public function get(): Cast&Transformer
+    {
+        return new ($this->class)(...$this->arguments);
+    }
+}

src/Casts/Cast.php

@@ -8,5 +8,5 @@
 
 interface Cast
 {
-    public function cast(DataProperty $property, mixed $value, Collection $properties, CreationContext $creationContext): mixed;
+    public function cast(DataProperty $property, mixed $value, Collection $properties, CreationContext $context): mixed;
 }

src/Concerns/ResponsableData.php

@@ -12,11 +12,6 @@
 
 trait ResponsableData
 {
-    /**
-     * @param \Illuminate\Http\Request $request
-     *
-     * @return \Symfony\Component\HttpFoundation\Response
-     */
     public function toResponse($request)
     {
         $contextFactory = TransformationContextFactory::create()

src/Contracts/ResponsableData.php

@@ -2,8 +2,18 @@
 
 namespace Spatie\LaravelData\Contracts;
 
-interface ResponsableData
+use Illuminate\Contracts\Support\Responsable;
+use Symfony\Component\HttpFoundation\Response;
+
+interface ResponsableData extends TransformableData, Responsable
 {
+    /**
+     * @param \Illuminate\Http\Request $request
+     *
+     * @return \Symfony\Component\HttpFoundation\Response
+     */
+    public function toResponse($request);
+
     public static function allowedRequestIncludes(): ?array;
 
     public static function allowedRequestExcludes(): ?array;

src/CursorPaginatedDataCollection.php

@@ -49,9 +49,11 @@ public function __construct(
     }
 
     /**
-     * @param Closure(TValue, TKey): TValue $through
+     * @template TOtherValue
      *
-     * @return static
+     * @param Closure(TValue, TKey): TOtherValue $through
+     *
+     * @return static<TKey, TOtherValue>
      */
     public function through(Closure $through): static
     {

src/PaginatedDataCollection.php

@@ -48,9 +48,11 @@ public function __construct(
     }
 
     /**
-     * @param Closure(TValue, TKey): TValue $through
+     * @template TOtherValue
      *
-     * @return static
+     * @param Closure(TValue, TKey): TOtherValue $through
+     *
+     * @return static<TKey, TOtherValue>
      */
     public function through(Closure $through): static
     {

src/Support/DataProperty.php

@@ -8,6 +8,7 @@
 use Spatie\LaravelData\Attributes\Computed;
 use Spatie\LaravelData\Attributes\GetsCast;
 use Spatie\LaravelData\Attributes\Hidden;
+use Spatie\LaravelData\Attributes\WithCastAndTransformer;
 use Spatie\LaravelData\Attributes\WithoutValidation;
 use Spatie\LaravelData\Attributes\WithTransformer;
 use Spatie\LaravelData\Casts\Cast;
@@ -89,7 +90,7 @@ className: $property->class,
             hasDefaultValue: $property->isPromoted() ? $hasDefaultValue : $property->hasDefaultValue(),
             defaultValue: $property->isPromoted() ? $defaultValue : $property->getDefaultValue(),
             cast: $attributes->first(fn (object $attribute) => $attribute instanceof GetsCast)?->get(),
-            transformer: $attributes->first(fn (object $attribute) => $attribute instanceof WithTransformer)?->get(),
+            transformer: $attributes->first(fn (object $attribute) => $attribute instanceof WithTransformer || $attribute instanceof WithCastAndTransformer)?->get(),
             inputMappedName: $inputMappedName,
             outputMappedName: $outputMappedName,
             attributes: $attributes,

tests/Fakes/CastTransformers/FakeCastTransformer.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Spatie\LaravelData\Tests\Fakes\CastTransformers;
+
+use Illuminate\Support\Collection;
+use Spatie\LaravelData\Casts\Cast;
+use Spatie\LaravelData\Support\Creation\CreationContext;
+use Spatie\LaravelData\Support\DataProperty;
+use Spatie\LaravelData\Support\Transformation\TransformationContext;
+use Spatie\LaravelData\Transformers\Transformer;
+
+class FakeCastTransformer implements Cast, Transformer
+{
+
+    public function cast(DataProperty $property, mixed $value, Collection $properties, CreationContext $context): mixed
+    {
+        return $value;
+    }
+
+    public function transform(DataProperty $property, mixed $value, TransformationContext $context): mixed
+    {
+        return $value;
+    }
+}

tests/Support/DataPropertyTest.php

@@ -6,12 +6,14 @@
 use Spatie\LaravelData\Attributes\MapInputName;
 use Spatie\LaravelData\Attributes\MapOutputName;
 use Spatie\LaravelData\Attributes\WithCast;
+use Spatie\LaravelData\Attributes\WithCastAndTransformer;
 use Spatie\LaravelData\Attributes\WithoutValidation;
 use Spatie\LaravelData\Attributes\WithTransformer;
 use Spatie\LaravelData\Casts\DateTimeInterfaceCast;
 use Spatie\LaravelData\Data;
 use Spatie\LaravelData\DataCollection;
 use Spatie\LaravelData\Support\DataProperty;
+use Spatie\LaravelData\Tests\Fakes\CastTransformers\FakeCastTransformer;
 use Spatie\LaravelData\Tests\Fakes\Models\DummyModel;
 use Spatie\LaravelData\Tests\Fakes\SimpleData;
 use Spatie\LaravelData\Transformers\DateTimeInterfaceTransformer;
@@ -53,6 +55,16 @@ function resolveHelper(
     expect($helper->transformer)->toEqual(new DateTimeInterfaceTransformer('d-m-y'));
 });
 
+it('can get the cast with transformer attribute', function () {
+    $helper = resolveHelper(new class () {
+        #[WithCastAndTransformer(FakeCastTransformer::class)]
+        public SimpleData $property;
+    });
+
+    expect($helper->transformer)->toEqual(new FakeCastTransformer());
+    expect($helper->cast)->toEqual(new FakeCastTransformer());
+});
+
 it('can get the mapped input name', function () {
     $helper = resolveHelper(new class () {
         #[MapInputName('other')]