silverstripe-framework/tests/php/Forms/NumericFieldTest.php

<?php

namespace SilverStripe\Forms\Tests;

use SilverStripe\Dev\SapphireTest;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\i18n\i18n;

class NumericFieldTest extends SapphireTest
{

    protected $usesDatabase = false;

    /**
     * In some cases and locales, validation expects non-breaking spaces.
     *
     * Duplicates non-public NumericField::clean method
     *
     * @param  string $input
     * @return string The input value, with all spaces replaced with non-breaking spaces
     */
    protected function clean($input)
    {
        $nbsp = html_entity_decode('&nbsp;', null, 'UTF-8');
        return str_replace(' ', $nbsp, trim($input));
    }

    protected function checkInputValidation($locale, $tests)
    {
        i18n::set_locale($locale);
        $field = new NumericField('Number');
        $validator = new RequiredFields('Number');

        foreach ($tests as $input => $output) {
            // Both decimal and thousands B
            $field->setValue($input);

            if ($output === false) {
                $this->assertFalse(
                    $field->validate($validator),
                    "Expect validation to fail for input $input in locale $locale"
                );
                $this->assertEquals(
                    0,
                    $field->dataValue(),
                    "Expect invalid value to be rewritten to 0 in locale $locale"
                );

                // Even invalid values shouldn't be rewritten
                $this->assertEquals(
                    $this->clean($input),
                    $field->Value(),
                    "Expected input $input to be saved in the field in locale $locale"
                );
            } else {
                $this->assertTrue(
                    $field->validate($validator),
                    "Expect validation to succeed for $input in locale $locale"
                );
                $this->assertEquals(
                    $output,
                    $field->dataValue(),
                    "Expect value $input to be mapped to $output in locale $locale"
                );
            }
        }
    }

    /**
     * Test that data loaded in via Form::loadDataFrom(DataObject) will populate the field correctly,
     * and can format the database value appropriately for the frontend
     *
     * @param string $locale
     * @param array  $tests
     */
    public function checkDataFormatting($locale, $tests)
    {
        i18n::set_locale($locale);
        $field = new NumericField('Number');
        /**
 * @skipUpgrade
*/
        $form = new Form(new Controller(), 'Form', new FieldList($field), new FieldList());
        $dataObject = new NumericFieldTest\TestObject();

        foreach ($tests as $input => $output) {
            // Given a dataobject as a context, the field should assume the field value is not localised
            $dataObject->Number = (string)$input;
            $form->loadDataFrom($dataObject, Form::MERGE_CLEAR_MISSING);

            // Test value
            $this->assertEquals(
                $input,
                $field->dataValue(),
                "Expected $input loaded via dataobject to be left intact in locale $locale"
            );

            // Test expected formatted value (Substitute nbsp for spaces)
            $this->assertEquals(
                $this->clean($output),
                $field->Value(),
                "Expected $input to be formatted as $output in locale $locale"
            );
        }
    }

    /**
     * German locale values (same as dutch)
     */
    public function testGermanLocales()
    {
        $this->checkDataFormatting(
            'de_DE',
            $formatting = array(
            '13000' => "13.000",
            '15' => '15',
            '12.0' => '12,0',
            '12.1' => '12,1',
            '14000.5' => "14.000,5",
            )
        );

        $this->checkDataFormatting('nl_NL', $formatting);

        $this->checkInputValidation(
            'de_DE',
            $validation = array(
            '13000' => 13000,
            '12,00' => 12.00,
            '12.00' => false,
            '11 000' => false,
            '11.000' => 11000,
            '11,000' => 11.0,
            '15 000,5' => false,
            '15 000.5' => false,
            '15.000,5' => 15000.5,
            '15,000.5' => false,
            )
        );

        $this->checkInputValidation('nl_NL', $validation);
    }

    /**
     * French locale values
     */
    public function testFrenchLocales()
    {
        $this->checkDataFormatting(
            'fr_FR',
            array(
            '13000' => "13 000",
            '15' => '15',
            '12.0' => '12,0',
            '12.1' => '12,1',
            '14000.5' => "14 000,5",
            )
        );

        $this->checkInputValidation(
            'fr_FR',
            array(
            '13000' => 13000,
            '12,00' => 12.00,
            '12.00' => false,
            '11 000' => 11000,
            '11.000' => false,
            '11,000' => 11.000,
            '15 000,5' => 15000.5,
            '15 000.5' => false,
            '15.000,5' => false,
            '15,000.5' => false,
            )
        );
    }

    /**
     * US locale values
     */
    public function testUSLocales()
    {
        $this->checkDataFormatting(
            'en_US',
            array(
            '13000' => "13,000",
            '15' => '15',
            '12.0' => '12.0',
            '12.1' => '12.1',
            '14000.5' => "14,000.5",
            )
        );

        $this->checkInputValidation(
            'en_US',
            array(
            '13000' => 13000,
            '12,00' => false,
            '12.00' => 12.00,
            '11 000' => false,
            '11.000' => 11.0,
            '11,000' => 11000,
            '15 000,5' => false,
            '15 000.5' => false,
            '15.000,5' => false,
            '15,000.5' => 15000.5,
            )
        );
    }

    public function testReadonly()
    {
        i18n::set_locale('en_US');
        $field = new NumericField('Number');
        $this->assertRegExp("#<span[^>]+>\s*0\s*<\/span>#", "".$field->performReadonlyTransformation()->Field()."");
    }

    public function testNumberTypeOnInputHtml()
    {
        $field = new NumericField('Number');

        $html = $field->Field();

        // @todo - Revert to number one day when html5 number supports proper localisation
        // See https://github.com/silverstripe/silverstripe-framework/pull/4565
        $this->assertContains('type="text"', $html, 'number type not set');
    }
}