Option to enforce state machine even when updating the record

[jigar-dhulla]

Currently, \Spatie\ModelStates\Exceptions\TransitionNotFound is triggered only when something like $payment->state->transitionTo(Paid::class); is used. This works just perfect.

Now, according to me and my team, even following should have thrown TransitionNotFound exception, but it is working.

$payment = Payment::whereState('state', Failed::class)->first();

$payment->state = 'paid'; // assuming invalid transition according to our config

$payment->save();

I understand that technically we are not transitioning but updating the record so package is working as expected.
But logically it should be restricted, I personally think.

We wanted to have this restriction in place for developers(esp. future) as well.

As of now, we have solved this by using the combination of PaymentObserver's updating() method and canTransitionTo().

Snippet from PaymentObserver:

    /**
     * Handle the Payment "updating" event.
     *
     * @param Payment $payment
     * @return void
     */
    public function updating(Payment $payment)
    {
        $oldPayment = $payment->getOriginal();
        if (!$oldPayment['state']->canTransitionTo($payment->state)) {
            throw TransitionNotAllowed::make($payment::class, $payment->state::class);
        }
    }

Let me know if I have overcomplicated simple thing and there is a better way to achieve this.

Also, If this is something that can be part of the package I can think more on this and work on raising a PR to add this behavior optionally. On top of my mind I can think of having a new optional trait EnforceStateTransitionsWhenUpdating