Merge pull request #189 from loadpartner/garrett/tms-103-shipment-lif…

…ecycle-state-system

Garrett/tms 103 shipment lifecycle state system

_ide_helper_actions.php

@@ -282,6 +282,20 @@ class SendInvite
 }
 namespace App\Actions\Shipments;
 
+/**
+ * @method static \Lorisleiva\Actions\Decorators\JobDecorator|\Lorisleiva\Actions\Decorators\UniqueJobDecorator makeJob(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Lorisleiva\Actions\Decorators\UniqueJobDecorator makeUniqueJob(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch dispatch(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent dispatchIf(bool $boolean, \App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent dispatchUnless(bool $boolean, \App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchSync(\App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchNow(\App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchAfterResponse(\App\Models\Shipments\Shipment $shipment)
+ * @method static \App\Models\Shipments\Shipment run(\App\Models\Shipments\Shipment $shipment)
+ */
+class CancelShipment
+{
+}
 /**
  * @method static \Lorisleiva\Actions\Decorators\JobDecorator|\Lorisleiva\Actions\Decorators\UniqueJobDecorator makeJob(array $customerIds, int $carrierId, array $stops, ?float $weight = null, ?float $tripDistance = null, ?int $trailerTypeId = null, ?int $trailerSizeId = null, ?bool $trailerTemperatureRange = false, ?float $trailerTemperature = null, ?float $trailerTemperatureMaximum = null, ?string $shipmentNumber = null)
  * @method static \Lorisleiva\Actions\Decorators\UniqueJobDecorator makeUniqueJob(array $customerIds, int $carrierId, array $stops, ?float $weight = null, ?float $tripDistance = null, ?int $trailerTypeId = null, ?int $trailerSizeId = null, ?bool $trailerTemperatureRange = false, ?float $trailerTemperature = null, ?float $trailerTemperatureMaximum = null, ?string $shipmentNumber = null)
@@ -296,6 +310,20 @@ class SendInvite
 class CreateShipment
 {
 }
+/**
+ * @method static \Lorisleiva\Actions\Decorators\JobDecorator|\Lorisleiva\Actions\Decorators\UniqueJobDecorator makeJob(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Lorisleiva\Actions\Decorators\UniqueJobDecorator makeUniqueJob(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch dispatch(\App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent dispatchIf(bool $boolean, \App\Models\Shipments\Shipment $shipment)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch|\Illuminate\Support\Fluent dispatchUnless(bool $boolean, \App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchSync(\App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchNow(\App\Models\Shipments\Shipment $shipment)
+ * @method static dispatchAfterResponse(\App\Models\Shipments\Shipment $shipment)
+ * @method static \App\Models\Shipments\Shipment run(\App\Models\Shipments\Shipment $shipment)
+ */
+class DispatchShipment
+{
+}
 /**
  * @method static \Lorisleiva\Actions\Decorators\JobDecorator|\Lorisleiva\Actions\Decorators\UniqueJobDecorator makeJob(\App\Models\Shipments\Shipment $shipment, int $carrierId)
  * @method static \Lorisleiva\Actions\Decorators\UniqueJobDecorator makeUniqueJob(\App\Models\Shipments\Shipment $shipment, int $carrierId)

app/Actions/Shipments/CancelShipment.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Actions\Shipments;
+
+use App\Models\Shipments\Shipment;
+use App\States\Shipments\Canceled;
+use Lorisleiva\Actions\ActionRequest;
+use Lorisleiva\Actions\Concerns\AsAction;
+
+class CancelShipment
+{
+    use AsAction;
+
+    public function handle(
+        Shipment $shipment,
+    ): Shipment {
+
+        $shipment->state->transitionTo(Canceled::class);
+
+        return $shipment;
+    }
+
+    public function asController(ActionRequest $request, Shipment $shipment)
+    {
+        $this->handle(
+            $shipment,
+        );
+
+        return redirect()->back()->with('success', 'Shipment canceled successfully');
+    }
+
+    public function rules(): array
+    {
+        return [
+        ];
+    }
+
+    public function authorize(ActionRequest $request): bool
+    {
+        return $request->user()->can(\App\Enums\Permission::SHIPMENT_EDIT);
+    }
+}

app/Actions/Shipments/DispatchShipment.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Actions\Shipments;
+
+use App\Enums\TemperatureUnit;
+use App\Http\Requests\Shipments\UpdateShipmentGeneralRequest;
+use App\Http\Requests\Shipments\UpdateShipmentNumberRequest;
+use App\Models\Shipments\Shipment;
+use App\States\Shipments\Dispatched;
+use Carbon\Carbon;
+use Illuminate\Support\Facades\DB;
+use Lorisleiva\Actions\ActionRequest;
+use Lorisleiva\Actions\Concerns\AsAction;
+use Nette\NotImplementedException;
+
+class DispatchShipment
+{
+    use AsAction;
+
+    public function handle(
+        Shipment $shipment,
+    ): Shipment {
+
+        $shipment->state->transitionTo(Dispatched::class);
+
+        return $shipment;
+    }
+
+    public function asController(ActionRequest $request, Shipment $shipment)
+    {
+        $this->handle(
+            $shipment,
+        );
+
+        return redirect()->back()->with('success', 'Shipment dispatched successfully');
+    }
+
+    public function rules(): array
+    {
+        return [
+        ];
+    }
+
+    public function authorize(ActionRequest $request): bool
+    {
+        return $request->user()->can(\App\Enums\Permission::SHIPMENT_EDIT);
+    }
+}

app/Actions/Shipments/UpdateShipmentCarrierDetails.php

@@ -2,15 +2,10 @@
 
 namespace App\Actions\Shipments;
 
-use App\Enums\TemperatureUnit;
-use App\Http\Requests\Shipments\UpdateShipmentGeneralRequest;
-use App\Http\Requests\Shipments\UpdateShipmentNumberRequest;
+use App\Events\Shipments\ShipmentCarrierUpdated;
 use App\Models\Shipments\Shipment;
-use Carbon\Carbon;
-use Illuminate\Support\Facades\DB;
 use Lorisleiva\Actions\ActionRequest;
 use Lorisleiva\Actions\Concerns\AsAction;
-use Nette\NotImplementedException;
 
 class UpdateShipmentCarrierDetails
 {
@@ -25,6 +20,8 @@ public function handle(
             'carrier_id' => $carrierId,
         ]);
 
+        event(new ShipmentCarrierUpdated($shipment));
+
         return $shipment;
     }
 

app/Actions/Shipments/UpdateShipmentStops.php

@@ -3,6 +3,7 @@
 namespace App\Actions\Shipments;
 
 use App\Enums\StopType;
+use App\Events\Shipments\ShipmentStopsUpdated;
 use App\Models\Shipments\Shipment;
 use App\Models\Shipments\ShipmentStop;
 use Illuminate\Validation\Rule;
@@ -26,6 +27,8 @@ public function handle(
             $shipment->stops()->updateOrCreate(['id' => $stop['id']], $stop);
         }
 
+        event(new ShipmentStopsUpdated($shipment));
+
         return $shipment;
     }
 

app/Events/Shipments/ShipmentCarrierUpdated.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Events\Shipments;
+
+use App\Models\Shipments\Shipment;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class ShipmentCarrierUpdated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Shipment $shipment,
+    ) {
+
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return array<int, \Illuminate\Broadcasting\Channel>
+     */
+    public function broadcastOn(): array
+    {
+        return [
+
+        ];
+    }
+}

app/Events/Shipments/ShipmentStopsUpdated.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Events\Shipments;
+
+use App\Models\Shipments\Shipment;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Broadcasting\PresenceChannel;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class ShipmentStopsUpdated
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /**
+     * Create a new event instance.
+     */
+    public function __construct(
+        public Shipment $shipment,
+    ) {
+
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return array<int, \Illuminate\Broadcasting\Channel>
+     */
+    public function broadcastOn(): array
+    {
+        return [
+
+        ];
+    }
+}

app/Http/Controllers/Shipments/ShipmentController.php

@@ -53,7 +53,7 @@ public function create()
     public function show(Shipment $shipment)
     {
         return Inertia::render('Shipments/Show', [
-            'shipment' => $shipment->load('carrier', 'customers'),
+            'shipment' => ShipmentResource::make($shipment->load('carrier', 'customers')),
             'stops' => ShipmentStopResource::collection($shipment->stops->load('facility')),
             'trailerTypes' => TrailerTypeResource::collection(TrailerType::all()),
             'trailerSizes' => TrailerSizeResource::collection(TrailerSize::all()),

app/Http/Resources/ShipmentResource.php

@@ -34,6 +34,8 @@ public function toArray(Request $request): array
             'stops' => ShipmentStopResource::collection($this->whenLoaded('stops')),
             'lane' => $this->whenLoaded('stops', $this->lane()),
             'next_stop' => $this->whenLoaded('stops', new ShipmentStopResource($this->nextStop)),
+            'state_label' => $this->state->label(),
+            'state' => $this->state,
         ];
     }
 }