NumberItemTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\field\Kernel\Number;

use Drupal\Core\Field\FieldItemInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\Plugin\Field\FieldType\NumericItemBase;
use Drupal\Core\Form\FormState;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\field\Entity\FieldConfig;
use Drupal\Tests\field\Kernel\FieldKernelTestBase;
use Drupal\field\Entity\FieldStorageConfig;

/**
 * Tests the new entity API for the number field type.
 *
 * @group field
 * @group #slow
 */
class NumberItemTest extends FieldKernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create number field storages and fields for validation.
        foreach ([
            'integer',
            'float',
            'decimal',
        ] as $type) {
            FieldStorageConfig::create([
                'entity_type' => 'entity_test',
                'field_name' => 'field_' . $type,
                'type' => $type,
            ])->save();
            FieldConfig::create([
                'entity_type' => 'entity_test',
                'field_name' => 'field_' . $type,
                'bundle' => 'entity_test',
            ])->save();
        }
    }
    
    /**
     * Tests using entity fields of the number field type.
     */
    public function testNumberItem() : void {
        // Verify entity creation.
        $entity = EntityTest::create();
        $integer = rand(0, 10);
        $entity->field_integer = $integer;
        $float = 3.14;
        $entity->field_float = $float;
        $entity->field_decimal = '20-40';
        $violations = $entity->validate();
        $this->assertCount(1, $violations, 'Wrong decimal value causes validation error');
        $decimal = '31.3';
        $entity->field_decimal = $decimal;
        $entity->name->value = $this->randomMachineName();
        $entity->save();
        // Verify entity has been created properly.
        $id = $entity->id();
        $entity = EntityTest::load($id);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_integer);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_integer[0]);
        $this->assertEquals($integer, $entity->field_integer->value);
        $this->assertEquals($integer, $entity->field_integer[0]->value);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_float);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_float[0]);
        $this->assertEquals($float, $entity->field_float->value);
        $this->assertEquals($float, $entity->field_float[0]->value);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_decimal);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_decimal[0]);
        $this->assertEquals((double) $decimal, $entity->field_decimal->value);
        $this->assertEquals((double) $decimal, $entity->field_decimal[0]->value);
        // Verify changing the number value.
        $new_integer = rand(11, 20);
        $new_float = rand(1001, 2000) / 100;
        $new_decimal = '18.2';
        $entity->field_integer->value = $new_integer;
        $this->assertEquals($new_integer, $entity->field_integer->value);
        $entity->field_float->value = $new_float;
        $this->assertEquals($new_float, $entity->field_float->value);
        $entity->field_decimal->value = $new_decimal;
        $this->assertEquals((double) $new_decimal, $entity->field_decimal->value);
        // Read changed entity and assert changed values.
        $entity->save();
        $entity = EntityTest::load($id);
        $this->assertEquals($new_integer, $entity->field_integer->value);
        $this->assertEquals($new_float, $entity->field_float->value);
        $this->assertEquals((double) $new_decimal, $entity->field_decimal->value);
        // Test sample item generation.
        $entity = EntityTest::create();
        // Make sure that field settings are respected by the generation.
        $entity->field_decimal
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_float
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_integer
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_decimal
            ->generateSampleItems();
        $entity->field_integer
            ->generateSampleItems();
        $entity->field_float
            ->generateSampleItems();
        // Confirm that the generated sample values are within range.
        $this->entityValidateAndSave($entity);
    }
    
    /**
     * Tests constraints on numeric item fields.
     *
     * @dataProvider dataNumberFieldSettingsProvider
     *
     * @param string $type
     *   The field type.
     * @param int|float $min
     *   The minimum field value.
     * @param int|float $max
     *   The maximum field value.
     * @param int|float $value
     *   The test value.
     * @param bool $expect_constraints
     *   If TRUE this data set will trigger a validation constraint.
     * @param string $expected_constraint_message
     *   The expected constraint violation message.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     */
    public function testConstraints($type, $min, $max, $value, $expect_constraints, $expected_constraint_message = '') : void {
        $field = FieldConfig::loadByName('entity_test', 'entity_test', 'field_' . $type);
        $field->setSetting('min', $min);
        $field->setSetting('max', $max);
        $field->save();
        $entity = EntityTest::create();
        $entity->{'field_' . $type} = $value;
        $violations = $entity->validate();
        $this->assertEquals($expect_constraints, $violations->count() > 0);
        if ($expect_constraints) {
            $this->assertEquals($expected_constraint_message, $violations->get(0)
                ->getMessage());
        }
    }
    
    /**
     * Data provider for testConstraints.
     *
     * @return \Generator
     *   The test data.
     */
    public static function dataNumberFieldSettingsProvider() {
        (yield [
            'integer',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'integer',
            0,
            NULL,
            -100,
            TRUE,
            'field_integer: the value may be no less than 0.',
        ]);
        (yield [
            'integer',
            10,
            NULL,
            100,
            FALSE,
        ]);
        (yield [
            'integer',
            10,
            NULL,
            5,
            TRUE,
            'field_integer: the value may be no less than 10.',
        ]);
        (yield [
            'integer',
            10,
            20,
            25,
            TRUE,
            'field_integer: the value may be no greater than 20.',
        ]);
        (yield [
            'integer',
            10,
            20,
            15,
            FALSE,
        ]);
        (yield [
            'float',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'float',
            0.003,
            NULL,
            0.0029,
            TRUE,
            'field_float: the value may be no less than 0.003.',
        ]);
        (yield [
            'float',
            10.05,
            NULL,
            13.4,
            FALSE,
        ]);
        (yield [
            'float',
            10,
            NULL,
            9.999000000000001,
            TRUE,
            'field_float: the value may be no less than 10.',
        ]);
        (yield [
            'float',
            1,
            2,
            2.5,
            TRUE,
            'field_float: the value may be no greater than 2.',
        ]);
        (yield [
            'float',
            1,
            2,
            1.5,
            FALSE,
        ]);
        (yield [
            'decimal',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'decimal',
            0.001,
            NULL,
            -0.05,
            TRUE,
            'field_decimal: the value may be no less than 0.001.',
        ]);
        (yield [
            'decimal',
            10.05,
            NULL,
            13.4,
            FALSE,
        ]);
        (yield [
            'decimal',
            10,
            NULL,
            9.999000000000001,
            TRUE,
            'field_decimal: the value may be no less than 10.',
        ]);
        (yield [
            'decimal',
            1,
            2,
            2.5,
            TRUE,
            'field_decimal: the value may be no greater than 2.',
        ]);
        (yield [
            'decimal',
            1,
            2,
            1.5,
            FALSE,
        ]);
    }
    
    /**
     * Tests the validation of minimum and maximum values.
     *
     * @param int|float|string $min
     *   Min value to be tested.
     * @param int|float|string $max
     *   Max value to be tested.
     * @param int|float|string $value
     *   Value to be tested with min and max values.
     * @param bool $hasError
     *   Expected validation result.
     * @param string $message
     *   (optional) Error message result.
     *
     * @dataProvider dataTestMinMaxValue
     */
    public function testFormFieldMinMaxValue(int|float|string $min, int|float|string $max, int|float|string $value, bool $hasError, string $message = '') : void {
        $element = [
            '#type' => 'number',
            '#title' => 'min',
            '#default_value' => $min,
            '#element_validate' => [
                [
                    NumericItemBase::class,
                    'validateMinAndMaxConfig',
                ],
            ],
            '#description' => 'The minimum value that should be allowed in this field. Leave blank for no minimum.',
            '#parents' => [],
            '#name' => 'min',
        ];
        $form_state = new FormState();
        $form_state->setValue('min', $value);
        $form_state->setValue('settings', [
            'min' => $min,
            'max' => $max,
            'prefix' => '',
            'suffix' => '',
            'precision' => 10,
            'scale' => 2,
        ]);
        $completed_form = [];
        NumericItemBase::validateMinAndMaxConfig($element, $form_state, $completed_form);
        $errors = $form_state->getErrors();
        $this->assertEquals($hasError, count($errors) > 0);
        if ($errors) {
            $error = current($errors);
            $this->assertEquals($error, $message);
        }
    }
    
    /**
     * Data provider for testFormFieldMinMaxValue().
     *
     * @return \Generator
     *   The test data.
     */
    public static function dataTestMinMaxValue() {
        (yield [
            1,
            10,
            5,
            FALSE,
            '',
        ]);
        (yield [
            10,
            5,
            6,
            TRUE,
            'The minimum value must be less than or equal to 5.',
        ]);
        (yield [
            1,
            0,
            6,
            TRUE,
            'The minimum value must be less than or equal to 0.',
        ]);
        (yield [
            0,
            -2,
            0.5,
            TRUE,
            'The minimum value must be less than or equal to -2.',
        ]);
        (yield [
            -10,
            -20,
            -5,
            TRUE,
            'The minimum value must be less than or equal to -20.',
        ]);
        (yield [
            1,
            '',
            -5,
            FALSE,
            '',
        ]);
        (yield [
            '',
            '',
            '',
            FALSE,
            '',
        ]);
        (yield [
            '2',
            '1',
            '',
            TRUE,
            'The minimum value must be less than or equal to 1.',
        ]);
    }

}