cakephp/tests/TestCase/View/Helper/NumberHelperTest.php

<?php
declare(strict_types=1);

/**
 * NumberHelperTest file
 *
 * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
 * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice
 *
 * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
 * @link          https://cakephp.org CakePHP(tm) Project
 * @since         1.2.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
namespace Cake\Test\TestCase\View\Helper;

use Cake\I18n\Number;
use Cake\TestSuite\TestCase;
use Cake\View\Helper\NumberHelper;
use Cake\View\View;
use ReflectionMethod;
use TestApp\I18n\NumberMock;
use TestApp\I18n\TestAppI18nEngine;
use TestApp\Utility\TestAppUtilityEngine;
use TestApp\View\Helper\NumberHelperTestObject;
use TestPlugin\I18n\TestPluginEngine;

/**
 * NumberHelperTest class
 */
class NumberHelperTest extends TestCase
{
    /**
     * @var \Cake\View\View
     */
    protected $View;

    /**
     * setUp method
     */
    public function setUp(): void
    {
        parent::setUp();
        $this->View = new View();
        static::setAppNamespace();
    }

    /**
     * tearDown method
     */
    public function tearDown(): void
    {
        parent::tearDown();
        $this->clearPlugins();
        unset($this->View);
    }

    /**
     * Provider for method proxying.
     *
     * @return array
     */
    public function methodProvider(): array
    {
        return [
            ['precision'],
            ['toReadableSize'],
            ['toPercentage'],
            ['currency'],
            ['format'],
            ['formatDelta'],
            ['ordinal'],
        ];
    }

    /**
     * test CakeNumber class methods are called correctly
     *
     * @dataProvider methodProvider
     */
    public function testNumberHelperProxyMethodCalls(string $method): void
    {
        $this->deprecated(function () use ($method) {
            $number = $this->getMockBuilder(NumberMock::class)
                ->addMethods([$method])
                ->getMock();
            $helper = new NumberHelperTestObject($this->View, ['engine' => NumberMock::class]);
            $helper->attach($number);
            $number->expects($this->once())
                ->method($method)
                ->with(12.3)
                ->willReturn('');
            $helper->{$method}(12.3);
        });
    }

    /**
     * Test that number of argument of helper's proxy methods matches
     * corresponding method of Number class.
     *
     * @dataProvider methodProvider
     */
    public function testParameterCountMatch(string $method): void
    {
        $numberMethod = new ReflectionMethod(Number::class, $method);
        $helperMethod = new ReflectionMethod(NumberHelper::class, $method);

        $this->assertSame($numberMethod->getNumberOfParameters(), $helperMethod->getNumberOfParameters());
    }

    /**
     * test engine override
     */
    public function testEngineOverride(): void
    {
        $this->deprecated(function () {
            $Number = new NumberHelperTestObject($this->View, ['engine' => 'TestAppI18nEngine']);
            $this->assertInstanceOf(TestAppI18nEngine::class, $Number->engine());

            $this->loadPlugins(['TestPlugin']);
            $Number = new NumberHelperTestObject($this->View, ['engine' => 'TestPlugin.TestPluginEngine']);
            $this->assertInstanceOf(TestPluginEngine::class, $Number->engine());
            $this->removePlugins(['TestPlugin']);
        });
    }

    /**
     * test engine override for legacy namespace Utility instead of I18n
     */
    public function testEngineOverrideLegacy(): void
    {
        $this->deprecated(function () {
            $Number = new NumberHelperTestObject($this->View, ['engine' => 'TestAppUtilityEngine']);
            $this->assertInstanceOf(TestAppUtilityEngine::class, $Number->engine());

            $this->loadPlugins(['TestPlugin']);
            $Number = new NumberHelperTestObject($this->View, ['engine' => 'TestPlugin.TestPluginEngine']);
            $this->assertInstanceOf(TestPluginEngine::class, $Number->engine());
            $this->removePlugins(['TestPlugin']);
        });
    }
}