yookassa-sdk-php/tests/Common/ListObjectTest.php

<?php
/*
 * The MIT License
 *
 * Copyright (c) 2026 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace Tests\YooKassa\Common;

use InvalidArgumentException;
use stdClass;
use YooKassa\Common\AbstractObject;
use YooKassa\Common\ListObject;
use PHPUnit\Framework\TestCase;
use YooKassa\Helpers\Random;
use YooKassa\Model\Deal\AbstractBaseDeal;
use YooKassa\Request\Payments\Airline;
use YooKassa\Request\Payments\Leg;
use YooKassa\Request\Payments\Passenger;
use YooKassa\Validator\Exceptions\EmptyPropertyValueException;
use YooKassa\Validator\Exceptions\InvalidPropertyValueException;

class ListObjectTest extends TestCase
{
    /**
     * @dataProvider validDataProvider
     * @param string $type
     * @param mixed $data
     * @return void
     */
    public function testGetSet(string $type, mixed $data): void
    {
        $instance = new ListObject($type, $data);

        $this->assertEquals($type, $instance->getType());
        $this->assertCount(is_array($data) ? count($data) : 0, $instance->getItems());
        $this->assertEquals(is_array($data) ? count($data) : 0, $instance->count());

        if (is_array($data) && count($data) > 0) {
            $cnt = count($data);
            $instance->remove(0);
            $this->assertCount($cnt - 1, $instance->getItems());
            $this->assertEquals($cnt - 1, $instance->count());
        }

        $instance = new ListObject($type, $data);

        if (is_array($data) && count($data) > 0) {
            $instance->clear();
            $this->assertCount(0, $instance->getItems());
            $this->assertEquals(0, $instance->count());
        }
    }

    /**
     * @return void
     */
    public function testChangeType(): void
    {
        $data = [
            ['first_name' => 'Michail', 'last_name' => 'Sidorov'],
            new Passenger(['first_name' => 'Alex', 'last_name' => 'Lutor']),
        ];

        $instance = new ListObject(Passenger::class);

        $this->assertEquals(Passenger::class, $instance->getType());
        $this->assertCount(0, $instance->getItems());
        $this->assertEquals(0, $instance->count());

        $instance->merge($data);

        $this->assertEquals(Passenger::class, $instance->getType());
        $this->assertCount(count($data), $instance->getItems());
        $this->assertEquals(count($data), $instance->count());

        $this->expectException(InvalidArgumentException::class);
        $instance->setType(Leg::class);

        $this->assertEquals(Passenger::class, $instance->getType());
    }

    /**
     * @return void
     */
    public function testOffsets(): void
    {
        $data = [
            ['first_name' => 'Michail', 'last_name' => 'Sidorov'],
            new Passenger(['first_name' => 'Alex', 'last_name' => 'Lutor']),
        ];

        $instance = new ListObject(Passenger::class, $data);

        $this->assertEquals($data[0], $instance->get(0)->toArray());
        $this->assertEquals($data[0], $instance[0]->toArray());

        $this->assertTrue(isset($instance[1]));
        unset($instance[1]);

        $this->assertCount(count($data) - 1, $instance->getItems());
        $this->assertEquals(count($data) - 1, $instance->count());

        $instance[] = ['first_name' => 'Alex', 'last_name' => 'Lutor'];

        $this->assertCount(count($data), $instance->getItems());
        $this->assertEquals(count($data), $instance->count());
    }

    /**
     * @dataProvider invalidDataProvider
     * @param string $type
     * @param mixed $data
     * @param string $exception
     * @return void
     */
    public function testSetInvalid(string $type, mixed $data, string $exception): void
    {
        $this->expectException($exception);
        new ListObject($type, $data);
    }

    public function validDataProvider(): array
    {
        return [
            [
                Airline::class,
                [
                    [
                        'booking_reference' => 'IIIKRV',
                        'ticket_number' => '12342123413',
                        'passengers' => [
                            [
                                'first_name' => 'SERGEI',
                                'last_name' => 'IVANOV',
                            ],
                        ],
                        'legs' => [
                            [
                                'departure_airport' => 'LED',
                                'destination_airport' => 'AMS',
                                'departure_date' => '2023-01-20',
                            ],
                        ],
                    ],
                ]
            ],
            [
                Passenger::class,
                [
                    ['first_name' => 'Michail', 'last_name' => 'Sidorov'],
                    new Passenger(['first_name' => 'Alex', 'last_name' => 'Lutor']),
                ]
            ],
            [
                Passenger::class,
                null
            ],
        ];
    }

    public function invalidDataProvider(): array
    {
        return [
            [
                Passenger::class,
                [
                    new stdClass(),
                ],
                InvalidArgumentException::class
            ],
            [
                Passenger::class,
                [
                    ['first_name' => null, 'last_name' => 'Sidorov'],
                ],
                EmptyPropertyValueException::class
            ],
            [
                Passenger::class,
                [
                    ['first_name' => 'Michail', 'last_name' => Random::str(65)],
                ],
                InvalidPropertyValueException::class
            ],
            [
                AbstractObject::class,
                [
                    [],
                ],
                InvalidArgumentException::class
            ],
            [
                AbstractBaseDeal::class,
                [
                    [],
                ],
                InvalidArgumentException::class
            ],
        ];
    }
}