ActionTrait.php

<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <rodolfo@chevere.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Chevere\Action\Traits;

use Chevere\Action\Exceptions\ActionException;
use Chevere\Action\Interfaces\ReflectionActionInterface;
use Chevere\Action\ReflectionAction;
use Chevere\Parameter\Interfaces\ParameterInterface;
use Chevere\Parameter\Interfaces\ParametersInterface;
use Throwable;
use function Chevere\Message\message;
use function Chevere\Parameter\mixed;

/**
 * @method mixed main()
 */
trait ActionTrait
{
    final public function __invoke(mixed ...$argument): mixed
    {
        try {
            $reflection = static::assert();
            $this->assertRuntime($reflection);
            $arguments = $reflection->parameters()->__invoke(...$argument);
        } catch (Throwable $e) {
            // @infection-ignore-all
            throw new ActionException(
                ...$this::getExceptionArguments($e),
            );
        }
        $result = $this->main(...$arguments->toArray());

        try {
            $reflection->return()->__invoke($result);
        } catch (Throwable $e) {
            // @infection-ignore-all
            throw new ActionException(
                ...$this::getExceptionArguments($e),
            );
        }

        return $result;
    }

    public static function return(): ParameterInterface
    {
        return mixed();
    }

    public static function mainMethod(): string
    {
        return 'main';
    }

    final public static function parameters(): ParametersInterface
    {
        try {
            $reflection = static::assert();

            return $reflection->parameters();
        } catch (Throwable $e) {
            // @infection-ignore-all
            throw new ActionException(
                ...self::getExceptionArguments($e),
            );
        }
    }

    final public static function assert(): ReflectionActionInterface
    {
        $reflection = new ReflectionAction(static::class);
        static::assertStatic($reflection);

        return $reflection;
    }

    /**
     * Enables to define extra parameter assertion before the run method is called.
     * @codeCoverageIgnore
     */
    protected static function assertStatic(ReflectionActionInterface $reflection): void
    {
        // enables extra static assertion
    }

    /**
     * Enables to define extra parameter assertion before the run method is called.
     * @codeCoverageIgnore
     */
    protected function assertRuntime(ReflectionActionInterface $reflection): void
    {
        // enables extra runtime assertion
    }

    // @phpstan-ignore-next-line
    private static function getExceptionArguments(Throwable $e): array
    {
        // @infection-ignore-all
        $caller = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2)[1];
        $message = (string) message(
            '`%actor%` %exception% → %message%',
            exception: $e::class,
            actor: static::class,
            message: $e->getMessage(),
        );

        // @infection-ignore-all
        return [
            $message,
            $e,
            $caller['file'] ?? 'na',
            $caller['line'] ?? 0,
        ];
    }
}