webeweb / jquery-datatables-bundle

Tests/Helper/DataTablesWrapperHelperTest.php

<?php

/*
 * This file is part of the jquery-datatables-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\JQuery\DataTablesBundle\Tests\Helper;

use Symfony\Component\Filesystem\Exception\FileNotFoundException;
use Throwable;
use WBW\Bundle\JQuery\DataTablesBundle\Factory\DataTablesFactory;
use WBW\Bundle\JQuery\DataTablesBundle\Helper\DataTablesWrapperHelper;
use WBW\Bundle\JQuery\DataTablesBundle\Tests\AbstractTestCase;
use WBW\Bundle\JQuery\DataTablesBundle\Tests\Fixtures\TestFixtures;

/**
 * DataTables wrapper helper test.
 *
 * @author webeweb <https://github.com/webeweb>
 * @package WBW\Bundle\JQuery\DataTablesBundle\Tests\Helper
 */
class DataTablesWrapperHelperTest extends AbstractTestCase {

    /**
     * Test getLanguageUrl()
     *
     * @return void
     * @throws Throwable Throws an exception if an error occurs.
     */
    public function testGetLanguageUrl(): void {

        $res = "/bundles/wbwjquerydatatables/datatables-i18n/French.json";
        $this->assertEquals($res, DataTablesWrapperHelper::getLanguageUrl("French"));
    }

    /**
     * Test getLanguageUrl()
     *
     * @return void
     */
    public function testGetLanguageUrlWithFileNotFoundException(): void {

        try {

            DataTablesWrapperHelper::getLanguageUrl("exception");
        } catch (Throwable $ex) {

            $this->assertInstanceOf(FileNotFoundException::class, $ex);
            $this->assertEquals('File "/bundles/wbwjquerydatatables/datatables-i18n/exception.json" could not be found.', $ex->getMessage());
        }
    }

    /**
     * Test getName()
     *
     * @return void
     */
    public function testGetName(): void {

        $this->dtProvider->expects($this->any())->method("getName")->willReturn("employee");

The method expects() does not exist on WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesProviderInterface.

The method expects() does not exist on null.

        $this->assertEquals("dtemployee", DataTablesWrapperHelper::getName(DataTablesFactory::newWrapper("url", $this->dtProvider)));

It seems like $this->dtProvider can also be of type null; however, parameter $provider of WBW\Bundle\JQuery\DataTablesBundle\Factory\DataTablesFactory::newWrapper() does only seem to accept WBW\Bundle\JQuery\DataTablesBundle\Provider\DataTablesProviderInterface, maybe add an additional type check?

        $this->dtProvider->expects($this->any())->method("getName")->willReturn("employee_");
        $this->assertEquals("dtemployee", DataTablesWrapperHelper::getName(DataTablesFactory::newWrapper("url", $this->dtProvider)));

        $this->dtProvider->expects($this->any())->method("getName")->willReturn("employee-");
        $this->assertEquals("dtemployee", DataTablesWrapperHelper::getName(DataTablesFactory::newWrapper("url", $this->dtProvider)));
    }

    /**
     * Test getOptions()
     *
     * @return void
     */
    public function testGetOptions(): void {

        $obj = TestFixtures::getWrapper();

        $res = [
            "ajax"       => [
                "type" => "POST",
                "url"  => "/datatables/employee/index",
            ],
            "columns"    => [
                ["cellType" => "td", "data" => "name", "name" => "Name"],
                ["cellType" => "td", "data" => "position", "name" => "Position"],
                ["cellType" => "td", "data" => "office", "name" => "Office"],
                ["cellType" => "td", "data" => "age", "name" => "Age"],
                ["cellType" => "td", "data" => "startDate", "name" => "Start date"],
                ["cellType" => "td", "data" => "salary", "name" => "Salary"],
                ["cellType" => "td", "data" => "actions", "name" => "Actions", "orderable" => false, "searchable" => false],
            ],
            "processing" => true,
            "serverSide" => true,
        ];
        $this->assertEquals($res, DataTablesWrapperHelper::getOptions($obj));
    }

    /**
     * Test hasSearch()
     *
     * @return void
     */
    public function testHasSearch(): void {

        $obj = TestFixtures::getWrapper();
        DataTablesFactory::parseWrapper($obj, $this->request);

        $this->assertFalse(DataTablesWrapperHelper::hasSearch($obj));
    }
}