Rename transformation to augmentation

Author: marcorieser

README.md

@@ -329,8 +329,8 @@ To make it work, you need to enable that feature first.
 2. Select `statamic-livewire` in the list
 3. Enable synthesizers
 
-#### Transformation
-By default, the Synthesizers transform (augment) the data before it gets passed into the view. You can disable this by setting `synthesizers.transform` to `false` in your published `config/statamic-livewire.php` config.
+#### Augmentation
+By default, the Synthesizers augment the data before it gets passed into the antlers view. You can disable this by setting `synthesizers.augmentation` to `false` in your published `config/statamic-livewire.php` config.
 
 ### Entangle: Sharing State Between Livewire And Alpine
 In case you want to share state between Livewire and Alpine, there is a Blade directive called `@entangle`. To be usable with Antlers, we do provide a dedicated tag:

config/statamic-livewire.php

@@ -53,7 +53,7 @@
             \MarcoRieser\Livewire\Synthesizers\ValueSynthesizer::class,
         ],
 
-        'transform' => true,
+        'augmentation' => true,
     ],
 
     /*

src/Contracts/Synthesizers/AugmentableSynthesizer.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MarcoRieser\Livewire\Contracts\Synthesizers;
+
+interface AugmentableSynthesizer
+{
+    public static function augment($target): mixed;
+}

src/Contracts/TransformableSynthesizer.php

@@ -3,37 +3,37 @@
 namespace MarcoRieser\Livewire\Hooks;
 
 use Livewire\ComponentHook;
-use MarcoRieser\Livewire\Contracts\TransformableSynthesizer;
+use MarcoRieser\Livewire\Contracts\Synthesizers\AugmentableSynthesizer;
 
-class TransformSynthesizers extends ComponentHook
+class SynthesizerAugmentor extends ComponentHook
 {
     public function render($view, $data): void
     {
         if (! config()->boolean('statamic-livewire.synthesizers.enabled', false)) {
             return;
         }
 
-        if (! config()->boolean('statamic-livewire.synthesizers.transform', true)) {
+        if (! config()->boolean('statamic-livewire.synthesizers.augmentation', true)) {
             return;
         }
 
-        $view->with($this->transformData($data));
+        $view->with($this->augment($data));
     }
 
     protected function getMatchingSynthesizer($value): ?string
     {
         return collect(config()->array('statamic-livewire.synthesizers.classes', []))
-            ->filter(fn (string $synthesizer) => is_subclass_of($synthesizer, TransformableSynthesizer::class) && call_user_func([$synthesizer, 'match'], $value))
+            ->filter(fn (string $synthesizer) => is_subclass_of($synthesizer, AugmentableSynthesizer::class) && call_user_func([$synthesizer, 'match'], $value))
             ->first();
     }
 
-    protected function transformData(array $data): array
+    protected function augment(array $data): array
     {
         return collect($data)
             ->map(function ($value) {
                 $synthesizer = $this->getMatchingSynthesizer($value);
 
-                return $synthesizer ? call_user_func([$synthesizer, 'transform'], $value) : $value;
+                return $synthesizer ? call_user_func([$synthesizer, 'augment'], $value) : $value;
             })
             ->all();
     }

src/Hooks/TransformSynthesizers.php src/Hooks/SynthesizerAugmentor.phpsrc/Hooks/TransformSynthesizers.php renamed to src/Hooks/SynthesizerAugmentor.php

@@ -7,7 +7,7 @@
 use Livewire\Livewire;
 use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
 use MarcoRieser\Livewire\Hooks\ComputedPropertiesAutoloader;
-use MarcoRieser\Livewire\Hooks\TransformSynthesizers;
+use MarcoRieser\Livewire\Hooks\SynthesizerAugmentor;
 use MarcoRieser\Livewire\Http\Middleware\ResolveCurrentSiteByLivewireUrl;
 use Statamic\Http\Middleware\Localize;
 use Statamic\Providers\AddonServiceProvider;
@@ -22,7 +22,7 @@ public function register(): void
     {
         parent::register();
 
-        $this->registerSynthesizerTransformations();
+        $this->registerSynthesizerAugmentation();
         $this->registerComputedPropertiesAutoloader();
     }
 
@@ -66,9 +66,9 @@ protected function bootSynthesizers(): void
             ->each(fn (string $synthesizer) => Livewire::propertySynthesizer($synthesizer));
     }
 
-    protected function registerSynthesizerTransformations(): void
+    protected function registerSynthesizerAugmentation(): void
     {
-        Livewire::componentHook(TransformSynthesizers::class);
+        Livewire::componentHook(SynthesizerAugmentor::class);
     }
 
     protected function registerComputedPropertiesAutoloader(): void

src/ServiceProvider.php

@@ -3,10 +3,10 @@
 namespace MarcoRieser\Livewire\Synthesizers;
 
 use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
-use MarcoRieser\Livewire\Contracts\TransformableSynthesizer;
+use MarcoRieser\Livewire\Contracts\Synthesizers\AugmentableSynthesizer;
 use Statamic\Entries\EntryCollection;
 
-class EntryCollectionSynthesizer extends Synth implements TransformableSynthesizer
+class EntryCollectionSynthesizer extends Synth implements AugmentableSynthesizer
 {
     public static string $key = 'slw_entryco';
 
@@ -15,7 +15,7 @@ public static function match($target): bool
         return $target instanceof EntryCollection;
     }
 
-    public static function transform($target): array
+    public static function augment($target): array
     {
         return $target->toAugmentedArray();
     }

src/Synthesizers/EntryCollectionSynthesizer.php

@@ -6,11 +6,11 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon;
 use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
-use MarcoRieser\Livewire\Contracts\TransformableSynthesizer;
+use MarcoRieser\Livewire\Contracts\Synthesizers\AugmentableSynthesizer;
 use Statamic\Contracts\Entries\Entry as EntryContract;
 use Statamic\Facades\Entry;
 
-class EntrySynthesizer extends Synth implements TransformableSynthesizer
+class EntrySynthesizer extends Synth implements AugmentableSynthesizer
 {
     public static string $key = 'slw_entry';
 
@@ -19,7 +19,7 @@ public static function match($target): bool
         return $target instanceof EntryContract;
     }
 
-    public static function transform($target): array
+    public static function augment($target): array
     {
         return $target->toAugmentedArray();
     }

src/Synthesizers/EntrySynthesizer.php

@@ -3,12 +3,12 @@
 namespace MarcoRieser\Livewire\Synthesizers;
 
 use Livewire\Mechanisms\HandleComponents\Synthesizers\Synth;
-use MarcoRieser\Livewire\Contracts\TransformableSynthesizer;
+use MarcoRieser\Livewire\Contracts\Synthesizers\AugmentableSynthesizer;
 use Statamic\Fields\Field;
 
 use function Livewire\invade;
 
-class FieldSynthesizer extends Synth implements TransformableSynthesizer
+class FieldSynthesizer extends Synth implements AugmentableSynthesizer
 {
     public static string $key = 'slw_field';
 
@@ -17,7 +17,7 @@ public static function match($target): bool
         return $target instanceof Field;
     }
 
-    public static function transform($target): mixed
+    public static function augment($target): mixed
     {
         return $target->augment();
     }

src/Synthesizers/FieldSynthesizer.php

@@ -16,14 +16,14 @@ protected function disableSynthesizers(): void
         $this->setConfigValue('synthesizers.enabled', false);
     }
 
-    protected function disableSynthesizerTransform(): void
+    protected function disableSynthesizerAugmentation(): void
     {
-        $this->setConfigValue('synthesizers.transform', false);
+        $this->setConfigValue('synthesizers.augmentation', false);
     }
 
-    protected function enableSynthesizerTransform(): void
+    protected function enableSynthesizerAugmentation(): void
     {
-        $this->setConfigValue('synthesizers.transform', true);
+        $this->setConfigValue('synthesizers.augmentation', true);
     }
 
     protected function setConfigValue(string $key, $value): void