Skip to content

[5.x] Support decimal values in Range fieldtype #13096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 5.x
Choose a base branch
from
Open

[5.x] Support decimal values in Range fieldtype #13096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions src/Fieldtypes/Range.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,22 @@ protected function configFieldItems(): array
'min' => [
'display' => __('Min'),
'instructions' => __('statamic::fieldtypes.range.config.min'),
'type' => 'integer',
'type' => 'text',
'input_type' => 'number',
'default' => 0,
],
'max' => [
'display' => __('Max'),
'instructions' => __('statamic::fieldtypes.range.config.max'),
'type' => 'integer',
'type' => 'text',
'input_type' => 'number',
'default' => 100,
],
'step' => [
'display' => __('Step'),
'instructions' => __('statamic::fieldtypes.range.config.step'),
'type' => 'integer',
'type' => 'text',
'input_type' => 'number',
'default' => 1,
],
'default' => [
Expand Down Expand Up @@ -62,11 +65,33 @@ protected function configFieldItems(): array

public function process($data)
{
if ($this->usesDecimals()) {
return (float) $data;
}

return (int) $data;
}

protected function usesDecimals(): bool
{
$step = $this->config('step', 1);
$min = $this->config('min', 0);
$max = $this->config('max', 100);

return $this->isDecimal($step) || $this->isDecimal($min) || $this->isDecimal($max);
}

protected function isDecimal($value): bool
{
if (! is_numeric($value)) {
return false;
}

return floor((float) $value) != (float) $value;
}

public function toGqlType()
{
return GraphQL::int();
return $this->usesDecimals() ? GraphQL::float() : GraphQL::int();
}
}
26 changes: 23 additions & 3 deletions tests/Feature/GraphQL/Fieldtypes/RangeFieldtypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
class RangeFieldtypeTest extends FieldtypeTestCase
{
#[Test]
public function it_gets_an_integer()
public function it_processes_integer_values_with_integer_config()
{
$this->createEntryWithFields([
'filled' => [
'value' => '7',
'field' => ['type' => 'range'],
'field' => ['type' => 'range', 'min' => 0, 'max' => 100, 'step' => 1],
],
'undefined' => [
'value' => null,
'field' => ['type' => 'range'],
'field' => ['type' => 'range', 'min' => 0, 'max' => 100, 'step' => 1],
],
]);

Expand All @@ -27,4 +27,24 @@ public function it_gets_an_integer()
'undefined' => null,
]);
}

#[Test]
public function it_processes_decimal_values_with_decimal_config()
{
$this->createEntryWithFields([
'filled' => [
'value' => '7.5',
'field' => ['type' => 'range', 'min' => 0, 'max' => 100, 'step' => 0.1],
],
'another' => [
'value' => '3.14',
'field' => ['type' => 'range', 'min' => 0, 'max' => 10, 'step' => 0.01],
],
]);

$this->assertGqlEntryHas('filled, another', [
'filled' => 7.5,
'another' => 3.14,
]);
}
}
137 changes: 137 additions & 0 deletions tests/Fieldtypes/RangeFieldtypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<?php

namespace Tests\Fieldtypes;

use PHPUnit\Framework\Attributes\Test;
use Statamic\Fields\Field;
use Statamic\Fieldtypes\Range;
use Tests\TestCase;

class RangeFieldtypeTest extends TestCase
{
#[Test]
public function it_processes_as_integer_with_integer_config()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 100,
'step' => 1,
]));

$result = $fieldtype->process('7');

$this->assertIsInt($result);
$this->assertEquals(7, $result);
}

#[Test]
public function it_processes_as_float_with_decimal_step()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 100,
'step' => 0.1,
]));

$result = $fieldtype->process('7.5');

$this->assertIsFloat($result);
$this->assertEquals(7.5, $result);
}

#[Test]
public function it_processes_as_float_with_decimal_min()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0.5,
'max' => 100,
'step' => 1,
]));

$result = $fieldtype->process('7');

$this->assertIsFloat($result);
$this->assertEquals(7.0, $result);
}

#[Test]
public function it_processes_as_float_with_decimal_max()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 99.9,
'step' => 1,
]));

$result = $fieldtype->process('7');

$this->assertIsFloat($result);
$this->assertEquals(7.0, $result);
}

#[Test]
public function it_processes_zero_as_integer_with_integer_config()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 100,
'step' => 1,
]));

$result = $fieldtype->process('0');

$this->assertIsInt($result);
$this->assertEquals(0, $result);
}

#[Test]
public function it_processes_negative_values_with_decimal_step()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => -10,
'max' => 10,
'step' => 0.5,
]));

$result = $fieldtype->process('-2.5');

$this->assertIsFloat($result);
$this->assertEquals(-2.5, $result);
}

#[Test]
public function it_returns_int_graphql_type_with_integer_config()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 100,
'step' => 1,
]));

$type = $fieldtype->toGqlType();

$this->assertEquals('Int', $type->name);
}

#[Test]
public function it_returns_float_graphql_type_with_decimal_config()
{
$fieldtype = (new Range())->setField(new Field('test', [
'type' => 'range',
'min' => 0,
'max' => 100,
'step' => 0.1,
]));

$type = $fieldtype->toGqlType();

$this->assertEquals('Float', $type->name);
}
}