scribe/tests/Strategies/GetFromInlineValidatorTest.php

<?php

namespace Knuckles\Scribe\Tests\Strategies;

use Closure;
use Knuckles\Camel\Extraction\ExtractedEndpointData;
use Knuckles\Scribe\Extracting\Strategies\BodyParameters;
use Knuckles\Scribe\Extracting\Strategies\QueryParameters;
use Knuckles\Scribe\Tests\BaseLaravelTest;
use Knuckles\Scribe\Tests\Fixtures;
use Knuckles\Scribe\Tests\Fixtures\TestController;
use Knuckles\Scribe\Tools\DocumentationConfig;
use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;

class GetFromInlineValidatorTest extends BaseLaravelTest
{
    use ArraySubsetAsserts;

    private static $expected = [
        'user_id' => [
            'type' => 'integer',
            'required' => true,
            'description' => 'The id of the user.',
            'example' => 9,
        ],
        'room_id' => [
            'type' => 'string',
            'required' => false,
            'description' => 'The id of the room. Must be one of <code>3</code>, <code>5</code>, or <code>6</code>.',
        ],
        'forever' => [
            'type' => 'boolean',
            'required' => false,
            'description' => 'Whether to ban the user forever.',
            'example' => false,
        ],
        'another_one' => [
            'type' => 'number',
            'required' => false,
            'description' => 'Just need something here.',
        ],
        'even_more_param' => [
            'type' => 'object',
            'required' => false,
            'description' => '',
        ],
        'book' => [
            'type' => 'object',
            'description' => '',
            'required' => false,
            'example' => [],
        ],
        'book.name' => [
            'type' => 'string',
            'description' => '',
            'required' => false,
        ],
        'book.author_id' => [
            'type' => 'integer',
            'description' => '',
            'required' => false,
        ],
        'book.pages_count' => [
            'type' => 'integer',
            'description' => '',
            'required' => false,
        ],
        'ids' => [
            'type' => 'integer[]',
            'description' => '',
            'required' => false,
        ],
        'users' => [
            'type' => 'object[]',
            'description' => '',
            'required' => false,
            'example' => [[]],
        ],
        'users[].first_name' => [
            'type' => 'string',
            'description' => 'The first name of the user.',
            'required' => false,
            'example' => 'John',
        ],
        'users[].last_name' => [
            'type' => 'string',
            'description' => 'The last name of the user.',
            'required' => false,
            'example' => 'Doe',
        ],
    ];

    /** @test */
    public function can_fetch_from_request_validate_assignment()
    {
        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineRequestValidate');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);
    }

    /** @test */
    public function can_fetch_from_request_validate_expression()
    {
        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineRequestValidateNoAssignment');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);
    }

    /** @test */
    public function can_fetch_from_request_validatewithbag()
    {
        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineRequestValidateWithBag');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);
    }

    /** @test */
    public function can_fetch_from_this_validate()
    {
        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineThisValidate');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);
    }

    /** @test */
    public function can_fetch_from_validator_make()
    {
        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineValidatorMake');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);
    }

    /** @test */
    public function respects_query_params_comment()
    {
        $queryParamsEndpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineRequestValidateQueryParams');
        });

        $results = $this->fetchViaBodyParams($queryParamsEndpoint);
        $this->assertEquals([], $results);

        $results = $this->fetchViaQueryParams($queryParamsEndpoint);
        $this->assertArraySubset(self::$expected, $results);
        $this->assertIsArray($results['ids']['example']);

        $bodyParamsEndpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withInlineRequestValidate');
        });
        $results = $this->fetchViaQueryParams($bodyParamsEndpoint);
        $this->assertEquals([], $results);
    }

    /** @test */
    public function can_fetch_inline_enum_rules()
    {
        if (phpversion() < 8.1) {
            $this->markTestSkipped('Enums are only supported in PHP 8.1 or later');
        }

        $endpoint = $this->endpoint(function (ExtractedEndpointData $e) {
            $e->method = new \ReflectionMethod(TestController::class, 'withEnumRule');
        });

        $results = $this->fetchViaBodyParams($endpoint);

        $expected = [
            'enum_class' => [
                'type' => 'string',
                'description' => 'Must be one of <code>red</code>, <code>green</code>, or <code>blue</code>.',
                'required' => true,
            ],
            'enum_string' => [
                'type' => 'string',
                'description' => 'Must be one of <code>1</code>, <code>2</code>, or <code>3</code>.',
                'required' => true,
            ],
            'enum_inexistent' => [
                'type' => 'string',
                'description' => 'Not full path class call won\'t work.',
                'required' => true,
            ],
        ];

        $getCase = fn ($case) => $case->value;

        $this->assertArraySubset($expected, $results);
        $this->assertTrue(in_array(
            $results['enum_class']['example'],
            array_map($getCase, Fixtures\TestStringBackedEnum::cases())
        ));
        $this->assertTrue(in_array(
            $results['enum_string']['example'],
            array_map($getCase, Fixtures\TestIntegerBackedEnum::cases())
        ));
    }

    protected function endpoint(Closure $configure): ExtractedEndpointData
    {
        $endpoint = new class extends ExtractedEndpointData {
            public function __construct(array $parameters = [])
            {
            }
        };
        $configure($endpoint);
        return $endpoint;
    }

    protected function fetchViaBodyParams(ExtractedEndpointData $endpoint): ?array
    {
        $strategy = new BodyParameters\GetFromInlineValidator(new DocumentationConfig([]));
        return $strategy($endpoint, []);
    }

    protected function fetchViaQueryParams(ExtractedEndpointData $endpoint): ?array
    {
        $strategy = new QueryParameters\GetFromInlineValidator(new DocumentationConfig([]));
        return $strategy($endpoint, []);
    }
}