tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

ENH Update AttributesHTML to output alt attribute even if it's empty (#11217)

Browse Source
This commit is contained in:
Maxime Rainville 2024-05-29 09:30:04 +12:00 committed by GitHub
parent 8886a3a93d
commit e35f12c66f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 325 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/View/AttributesHTML.php
View File

@ -105,9 +105,9 @@ trait AttributesHTML
$attributes = (array) $attributes; $attributes = (array) $attributes;
$attributes = array_filter($attributes ?? [], function ($v) { $attributes = array_filter($attributes ?? [], function ($v, $k) {
return ($v || $v === 0 || $v === '0'); return ($k === 'alt' || $v || $v === 0 || $v === '0');
}); }, ARRAY_FILTER_USE_BOTH);
if ($exclude) { if ($exclude) {
$attributes = array_diff_key( $attributes = array_diff_key(

290
tests/php/View/AttributesHTMLTest.php Normal file
View File

@ -0,0 +1,290 @@
<?php
namespace SilverStripe\View\Tests;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\View\Tests\AttributesHTMLTest\DummyAttributesHTML;
class AttributesHTMLTest extends SapphireTest
{
public function provideGetAttribute(): array
{
return [
'empty string' => ['test', '', 'Empty string is not converted to a different falsy value'],
'Zero' => ['test', 0, 'Zero is not converted to a different falsy value'],
'Null' => ['test', 0, 'Null is not converted to a different falsy value'],
'False' => ['test', false, 'False is not converted to a different falsy value'],
'Empty array' => ['test', [], 'Empty array is not converted to a different falsy value'],
'True' => ['test', true, 'True is stored properly as an attribute'],
'String' => ['test', 'test', 'String is stored properly as an attribute'],
'Int' => ['test', -1, 'Int is stored properly as an attribute'],
'Array' => ['test', ['foo' => 'bar'], 'Array is stored properly as an attribute'],
];
}
/** @dataProvider provideGetAttribute */
public function testGetAttribute($name, $value, $message): void
{
$dummy = new DummyAttributesHTML();
$this->assertNull(
$dummy->getAttribute('non-existent attribute'),
'Trying to access a non-existent attribute should return null'
);
$dummy->setAttribute($name, $value);
$this->assertSame(
$value,
$dummy->getAttribute($name),
$message
);
}
public function testGetAttributes(): void
{
$dummy = new DummyAttributesHTML();
$dummy->setDefaultAttributes([]);
$this->assertSame(
[],
$dummy->getAttributes(),
'When no attributes are set and the default attributes are empty, an empty array should be returned'
);
$dummy->setAttribute('empty', '');
$dummy->setAttribute('foo', 'bar');
$dummy->setAttribute('Number', 123);
$dummy->setAttribute('Array', ['foo' => 'bar']);
$this->assertSame(
[
'empty' => '',
'foo' => 'bar',
'Number' => 123,
'Array' => ['foo' => 'bar'],
],
$dummy->getAttributes(),
'All explicitly defined attributes should be returned'
);
$dummy = new DummyAttributesHTML();
$dummy->setDefaultAttributes([
'foo' => 'Will be overridden',
'bar' => 'Not overridden',
]);
$this->assertSame(
[
'foo' => 'Will be overridden',
'bar' => 'Not overridden',
],
$dummy->getAttributes(),
'When no attributes are set and the default attributes are used'
);
$dummy->setAttribute('empty', '');
$dummy->setAttribute('foo', 'bar');
$dummy->setAttribute('Number', 123);
$dummy->setAttribute('Array', ['foo' => 'bar']);
$this->assertSame(
[
'foo' => 'bar',
'bar' => 'Not overridden',
'empty' => '',
'Number' => 123,
'Array' => ['foo' => 'bar'],
],
$dummy->getAttributes(),
'Explicitly defined attributes overrides default ones'
);
}
public function testAttributesHTML(): void
{
$dummy = new DummyAttributesHTML();
$dummy->setAttribute('emptystring', '');
$dummy->setAttribute('nullvalue', null);
$dummy->setAttribute('false', false);
$dummy->setAttribute('emptyarray', []);
$dummy->setAttribute('zeroint', 0);
$dummy->setAttribute('zerostring', '0');
$dummy->setAttribute('alt', '');
$dummy->setAttribute('array', ['foo' => 'bar']);
$dummy->setAttribute('width', 123);
$dummy->setAttribute('hack>', '">hack');
$html = $dummy->getAttributesHTML();
$this->assertStringNotContainsString(
'emptystring',
$html,
'Attribute with empty string are not rendered'
);
$this->assertStringNotContainsString(
'nullvalue',
$html,
'Attribute with null are not rendered'
);
$this->assertStringNotContainsString(
'false',
$html,
'Attribute with false are not rendered'
);
$this->assertStringNotContainsString(
'emptyarray',
$html,
'Attribute with empty array are not rendered'
);
$this->assertStringContainsString(
'zeroint="0"',
$html,
'Attribute with a zero int value are rendered'
);
$this->assertStringContainsString(
'zerostring="0"',
$html,
'Attribute with a zerostring value are rendered'
);
$this->assertStringContainsString(
'alt=""',
$html,
'alt attribute is rendered even when empty set to an empty string'
);
$this->assertStringContainsString(
'array="{&quot;foo&quot;:&quot;bar&quot;}"',
$html,
'Array attribute is converted to JSON'
);
$this->assertStringContainsString(
'width="123"',
$html,
'Numeric values are rendered with quotes'
);
$this->assertStringNotContainsString(
'hack&quot;&gt;="&quot;&gt;hack"',
$html,
'Attribute names and value are escaped'
);
$html = $dummy->getAttributesHTML('zeroint', 'array');
$this->assertStringNotContainsString(
'zeroint="0"',
$html,
'Excluded attributes are not rendered'
);
$this->assertStringContainsString(
'zerostring="0"',
$html,
'Attribute not excluded still render'
);
$this->assertStringContainsString(
'alt=""',
$html,
'Attribute not excluded still render'
);
$this->assertStringNotContainsString(
'array',
$html,
'Excluded attributes are not rendered'
);
}
public function testAttributesHTMLwithExplicitAttr(): void
{
$dummy = new DummyAttributesHTML();
$this->assertEmpty(
'',
$dummy->getAttributesHTML(),
'If no attributes are provided, an empty string should be returned'
);
$attributes = [
'emptystring' => '',
'nullvalue' => null,
'false' => false,
'emptyarray' => [],
'zeroint' => 0,
'zerostring' => '0',
'alt' => '',
'array' => ['foo' => 'bar'],
'width' => 123,
'hack>' => '">hack',
];
$html = $dummy->getAttributesHTML($attributes);
$this->assertStringNotContainsString(
'emptystring',
$html,
'Attribute with empty string are not rendered'
);
$this->assertStringNotContainsString(
'nullvalue',
$html,
'Attribute with null are not rendered'
);
$this->assertStringNotContainsString(
'false',
$html,
'Attribute with false are not rendered'
);
$this->assertStringNotContainsString(
'emptyarray',
$html,
'Attribute with empty array are not rendered'
);
$this->assertStringContainsString(
'zeroint="0"',
$html,
'Attribute with a zero int value are rendered'
);
$this->assertStringContainsString(
'zerostring="0"',
$html,
'Attribute with a zerostring value are rendered'
);
$this->assertStringContainsString(
'alt=""',
$html,
'alt attribute is rendered even when empty set to an empty string'
);
$this->assertStringContainsString(
'array="{&quot;foo&quot;:&quot;bar&quot;}"',
$html,
'Array attribute is converted to JSON'
);
$this->assertStringContainsString(
'width="123"',
$html,
'Numeric values are rendered with quotes'
);
$this->assertStringNotContainsString(
'hack&quot;&gt;="&quot;&gt;hack"',
$html,
'Attribute names and value are escaped'
);
}
}

32
tests/php/View/AttributesHTMLTest/DummyAttributesHTML.php Normal file
View File

@ -0,0 +1,32 @@
<?php
namespace SilverStripe\View\Tests\AttributesHTMLTest;
use SilverStripe\View\AttributesHTML;
use SilverStripe\Dev\TestOnly;
/**
* This call is used to test the AttributesHTML trait
*/
class DummyAttributesHTML implements TestOnly
{
use AttributesHTML;
private array $defaultAttributes = [];
/**
* Trait requires this method to prepopulate the attributes
*/
protected function getDefaultAttributes(): array
{
return $this->defaultAttributes;
}
/**
* This method is only there to allow to explicitly set the default attributes in the test.
*/
public function setDefaultAttributes(array $attributes): void
{
$this->defaultAttributes = $attributes;
}
}