Add rules to requests and make naming explicit (#169)

Signed-off-by: Joel Butcher <[email protected]> Co-authored-by: James Brooks <[email protected]>
cachethq · Jan 8, 2025 · 88960af · 88960af
1 parent b3a5388
commit 88960af
Show file tree

Hide file tree

Showing 70 changed files with 514 additions and 334 deletions.
diff --git a/src/Actions/Component/CreateComponent.php b/src/Actions/Component/CreateComponent.php
@@ -2,15 +2,15 @@
 
 namespace Cachet\Actions\Component;
 
-use Cachet\Data\Component\CreateComponentData;
+use Cachet\Data\Requests\Component\CreateComponentRequestData;
 use Cachet\Models\Component;
 
 class CreateComponent
 {
     /**
      * Handle the action.
      */
-    public function handle(CreateComponentData $component): Component
+    public function handle(CreateComponentRequestData $component): Component
     {
         return Component::create($component->toArray());
     }

diff --git a/src/Actions/Component/UpdateComponent.php b/src/Actions/Component/UpdateComponent.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\Component;
 
-use Cachet\Data\Component\UpdateComponentData;
+use Cachet\Data\Requests\Component\UpdateComponentRequestData;
 use Cachet\Events\Components\ComponentStatusWasChanged;
 use Cachet\Models\Component;
 
@@ -11,7 +11,7 @@ class UpdateComponent
     /**
      * Handle the action.
      */
-    public function handle(Component $component, UpdateComponentData $data): Component
+    public function handle(Component $component, UpdateComponentRequestData $data): Component
     {
         $oldStatus = $component->status;
 

diff --git a/src/Actions/ComponentGroup/CreateComponentGroup.php b/src/Actions/ComponentGroup/CreateComponentGroup.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\ComponentGroup;
 
-use Cachet\Data\ComponentGroup\CreateComponentGroupData;
+use Cachet\Data\Requests\ComponentGroup\CreateComponentGroupRequestData;
 use Cachet\Models\Component;
 use Cachet\Models\ComponentGroup;
 
@@ -14,7 +14,7 @@ class CreateComponentGroup
     /**
      * Handle the action.
      */
-    public function handle(CreateComponentGroupData $data): ComponentGroup
+    public function handle(CreateComponentGroupRequestData $data): ComponentGroup
     {
         return tap(ComponentGroup::create(
             $data->except('components')->toArray(),

diff --git a/src/Actions/ComponentGroup/UpdateComponentGroup.php b/src/Actions/ComponentGroup/UpdateComponentGroup.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\ComponentGroup;
 
-use Cachet\Data\ComponentGroup\UpdateComponentGroupData;
+use Cachet\Data\Requests\ComponentGroup\UpdateComponentGroupRequestData;
 use Cachet\Models\Component;
 use Cachet\Models\ComponentGroup;
 
@@ -11,7 +11,7 @@ class UpdateComponentGroup
     /**
      * Handle the action.
      */
-    public function handle(ComponentGroup $componentGroup, UpdateComponentGroupData $data): ComponentGroup
+    public function handle(ComponentGroup $componentGroup, UpdateComponentGroupRequestData $data): ComponentGroup
     {
         $componentGroup->update($data->except('components')->toArray());
 

diff --git a/src/Actions/Incident/CreateIncident.php b/src/Actions/Incident/CreateIncident.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\Incident;
 
-use Cachet\Data\Incident\CreateIncidentData;
+use Cachet\Data\Requests\Incident\CreateIncidentRequestData;
 use Cachet\Models\Component;
 use Cachet\Models\Incident;
 use Cachet\Models\IncidentTemplate;
@@ -14,7 +14,7 @@ class CreateIncident
     /**
      * Handle the action.
      */
-    public function handle(CreateIncidentData $data): Incident
+    public function handle(CreateIncidentRequestData $data): Incident
     {
         if (isset($data->template)) {
             $template = IncidentTemplate::query()
@@ -35,7 +35,7 @@ public function handle(CreateIncidentData $data): Incident
     /**
      * Render the incident template with the given data.
      */
-    private function parseTemplate(IncidentTemplate $template, CreateIncidentData $data): string
+    private function parseTemplate(IncidentTemplate $template, CreateIncidentRequestData $data): string
     {
         $vars = array_merge($data->templateVars, [
             'incident' => [

diff --git a/src/Actions/Incident/UpdateIncident.php b/src/Actions/Incident/UpdateIncident.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\Incident;
 
-use Cachet\Data\Incident\UpdateIncidentData;
+use Cachet\Data\Requests\Incident\UpdateIncidentRequestData;
 use Cachet\Events\Incidents\IncidentUpdated;
 use Cachet\Models\Incident;
 
@@ -11,7 +11,7 @@ class UpdateIncident
     /**
      * Handle the action.
      */
-    public function handle(Incident $incident, UpdateIncidentData $data): Incident
+    public function handle(Incident $incident, UpdateIncidentRequestData $data): Incident
     {
         $incident->update($data->toArray());
 

diff --git a/src/Actions/IncidentTemplate/CreateIncidentTemplate.php b/src/Actions/IncidentTemplate/CreateIncidentTemplate.php
@@ -2,15 +2,15 @@
 
 namespace Cachet\Actions\IncidentTemplate;
 
-use Cachet\Data\IncidentTemplate\CreateIncidentTemplateData;
+use Cachet\Data\Requests\IncidentTemplate\CreateIncidentTemplateRequestData;
 use Cachet\Models\IncidentTemplate;
 
 class CreateIncidentTemplate
 {
     /**
      * Handle the action.
      */
-    public function handle(CreateIncidentTemplateData $data): IncidentTemplate
+    public function handle(CreateIncidentTemplateRequestData $data): IncidentTemplate
     {
         return IncidentTemplate::create($data->toArray());
     }

diff --git a/src/Actions/IncidentTemplate/UpdateIncidentTemplate.php b/src/Actions/IncidentTemplate/UpdateIncidentTemplate.php
@@ -2,15 +2,15 @@
 
 namespace Cachet\Actions\IncidentTemplate;
 
-use Cachet\Data\IncidentTemplate\UpdateIncidentTemplateData;
+use Cachet\Data\Requests\IncidentTemplate\UpdateIncidentTemplateRequestData;
 use Cachet\Models\IncidentTemplate;
 
 class UpdateIncidentTemplate
 {
     /**
      * Handle the action.
      */
-    public function handle(IncidentTemplate $incidentTemplate, UpdateIncidentTemplateData $data): IncidentTemplate
+    public function handle(IncidentTemplate $incidentTemplate, UpdateIncidentTemplateRequestData $data): IncidentTemplate
     {
         $incidentTemplate->update($data->toArray());
 

diff --git a/src/Actions/Metric/CreateMetric.php b/src/Actions/Metric/CreateMetric.php
@@ -2,15 +2,15 @@
 
 namespace Cachet\Actions\Metric;
 
-use Cachet\Data\Metric\CreateMetricData;
+use Cachet\Data\Requests\Metric\CreateMetricRequestData;
 use Cachet\Models\Metric;
 
 class CreateMetric
 {
     /**
      * Handle the action.
      */
-    public function handle(CreateMetricData $data): Metric
+    public function handle(CreateMetricRequestData $data): Metric
     {
         return Metric::create($data->toArray());
     }

diff --git a/src/Actions/Metric/CreateMetricPoint.php b/src/Actions/Metric/CreateMetricPoint.php
@@ -2,7 +2,7 @@
 
 namespace Cachet\Actions\Metric;
 
-use Cachet\Data\Metric\CreateMetricPointData;
+use Cachet\Data\Requests\Metric\CreateMetricPointRequestData;
 use Cachet\Models\Metric;
 use Cachet\Models\MetricPoint;
 
@@ -11,7 +11,7 @@ class CreateMetricPoint
     /**
      * Handle the action.
      */
-    public function handle(Metric $metric, ?CreateMetricPointData $data = null): MetricPoint
+    public function handle(Metric $metric, ?CreateMetricPointRequestData $data = null): MetricPoint
     {
         $lastPoint = $metric->metricPoints()->latest()->first();
 

diff --git a/src/Actions/Metric/UpdateMetric.php b/src/Actions/Metric/UpdateMetric.php
@@ -2,15 +2,15 @@
 
 namespace Cachet\Actions\Metric;
 
-use Cachet\Data\Metric\UpdateMetricData;
+use Cachet\Data\Requests\Metric\UpdateMetricRequestData;
 use Cachet\Models\Metric;
 
 class UpdateMetric
 {
     /**
      * Handle the action.
      */
-    public function handle(Metric $metric, UpdateMetricData $data): Metric
+    public function handle(Metric $metric, UpdateMetricRequestData $data): Metric
     {
         $metric->update($data->toArray());
 

diff --git a/src/Actions/Schedule/CreateSchedule.php b/src/Actions/Schedule/CreateSchedule.php
@@ -2,23 +2,23 @@
 
 namespace Cachet\Actions\Schedule;
 
-use Cachet\Data\Schedule\CreateScheduleData;
-use Cachet\Data\Schedule\ScheduleComponentData;
+use Cachet\Data\Requests\Schedule\CreateScheduleRequestData;
+use Cachet\Data\Requests\Schedule\ScheduleComponentRequestData;
 use Cachet\Models\Schedule;
 
 class CreateSchedule
 {
     /**
      * Handle the action.
      */
-    public function handle(CreateScheduleData $data): Schedule
+    public function handle(CreateScheduleRequestData $data): Schedule
     {
         return tap(Schedule::create($data->except('components')->toArray()), function (Schedule $schedule) use ($data) {
             if (! $data->components) {
                 return;
             }
 
-            $components = collect($data->components)->map(fn (ScheduleComponentData $component) => [
+            $components = collect($data->components)->map(fn (ScheduleComponentRequestData $component) => [
                 'component_id' => $component->id,
                 'component_status' => $component->status,
             ])->all();

diff --git a/src/Actions/Schedule/UpdateSchedule.php b/src/Actions/Schedule/UpdateSchedule.php
@@ -2,21 +2,21 @@
 
 namespace Cachet\Actions\Schedule;
 
-use Cachet\Data\Schedule\ScheduleComponentData;
-use Cachet\Data\Schedule\UpdateScheduleData;
+use Cachet\Data\Requests\Schedule\ScheduleComponentRequestData;
+use Cachet\Data\Requests\Schedule\UpdateScheduleRequestData;
 use Cachet\Models\Schedule;
 
 class UpdateSchedule
 {
     /**
      * Handle the action.
      */
-    public function handle(Schedule $schedule, UpdateScheduleData $data): Schedule
+    public function handle(Schedule $schedule, UpdateScheduleRequestData $data): Schedule
     {
         $schedule->update($data->except('components')->toArray());
 
         if ($data->components) {
-            $components = collect($data->components)->map(fn (ScheduleComponentData $component) => [
+            $components = collect($data->components)->map(fn (ScheduleComponentRequestData $component) => [
                 'component_id' => $component->id,
                 'component_status' => $component->status,
             ])->all();

diff --git a/src/Actions/Update/CreateUpdate.php b/src/Actions/Update/CreateUpdate.php
@@ -2,8 +2,8 @@
 
 namespace Cachet\Actions\Update;
 
-use Cachet\Data\IncidentUpdate\CreateIncidentUpdateData;
-use Cachet\Data\ScheduleUpdate\CreateScheduleUpdateData;
+use Cachet\Data\Requests\IncidentUpdate\CreateIncidentUpdateRequestData;
+use Cachet\Data\Requests\ScheduleUpdate\CreateScheduleUpdateRequestData;
 use Cachet\Models\Incident;
 use Cachet\Models\Schedule;
 use Cachet\Models\Update;
@@ -13,7 +13,7 @@ class CreateUpdate
     /**
      * Handle the action.
      */
-    public function handle(Incident|Schedule $resource, CreateIncidentUpdateData|CreateScheduleUpdateData $data): Update
+    public function handle(Incident|Schedule $resource, CreateIncidentUpdateRequestData|CreateScheduleUpdateRequestData $data): Update
     {
         $update = new Update(array_merge(['user_id' => auth()->id()], $data->toArray()));
 

diff --git a/src/Actions/Update/EditUpdate.php b/src/Actions/Update/EditUpdate.php
@@ -2,16 +2,16 @@
 
 namespace Cachet\Actions\Update;
 
-use Cachet\Data\IncidentUpdate\EditIncidentUpdateData;
-use Cachet\Data\ScheduleUpdate\EditScheduleUpdateData;
+use Cachet\Data\Requests\IncidentUpdate\EditIncidentUpdateRequestData;
+use Cachet\Data\Requests\ScheduleUpdate\EditScheduleUpdateRequestData;
 use Cachet\Models\Update;
 
 class EditUpdate
 {
     /**
      * Handle the action.
      */
-    public function handle(Update $update, EditIncidentUpdateData|EditScheduleUpdateData $data): Update
+    public function handle(Update $update, EditIncidentUpdateRequestData|EditScheduleUpdateRequestData $data): Update
     {
         return tap($update, function (Update $update) use ($data) {
             $update->update($data->toArray());

diff --git a/src/Data/BaseData.php b/src/Data/BaseData.php
@@ -4,8 +4,17 @@
 
 use Spatie\LaravelData\Data;
 
+/**
+ * @template TKey of array-key
+ * @template TValue
+ */
 abstract class BaseData extends Data
 {
+    /**
+     * Get the instance as an array.
+     *
+     * @return array<TKey, TValue>
+     */
     public function toArray(): array
     {
         return array_filter(

diff --git a/src/Data/Cachet/ThemeData.php b/src/Data/Cachet/ThemeData.php
@@ -9,7 +9,7 @@
 use Spatie\LaravelData\Attributes\Computed;
 use Spatie\LaravelData\Attributes\Validation\Required;
 
-class ThemeData extends BaseData
+final class ThemeData extends BaseData
 {
     public const GRAYS = ['slate', 'gray', 'zinc', 'neutral', 'stone'];
 

diff --git a/src/Data/IncidentUpdate/CreateIncidentUpdateData.php b/src/Data/IncidentUpdate/CreateIncidentUpdateData.php
diff --git a/src/Data/IncidentUpdate/EditIncidentUpdateData.php b/src/Data/IncidentUpdate/EditIncidentUpdateData.php
diff --git a/src/Data/Metric/CreateMetricPointData.php b/src/Data/Metric/CreateMetricPointData.php