Shikiryu/ShikiryuRSS
1
0
Fork 0
mirror of https://github.com/Chouchen/ShikiryuRSS.git synced 2024-05-19 06:11:32 +02:00
Code Issues Releases Wiki Activity

🧪 Add failing tests

Browse Source 
Closes #3
This commit is contained in:
Clement Desmidt 2023-04-19 16:15:35 +02:00
parent cae3c6f2dc
commit 0935c343ea
6 changed files with 288 additions and 130 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/Entity/Item.php
View File

@ -12,6 +12,17 @@ use Shikiryu\SRSS\Validator\Validator;
/** /**
* https://cyber.harvard.edu/rss/rss.html#hrelementsOfLtitemgt * https://cyber.harvard.edu/rss/rss.html#hrelementsOfLtitemgt
* @property null|string title
* @property null|string link
* @property null|string description
* @property null|string author
* @property null|array category
* @property null|string comments
* @property null|Enclosure enclosure
* @property null|string guid
* @property null|string pubDate
* @property null|Source source
* @property array medias
*/ */
class Item extends HasValidator implements SRSSElement class Item extends HasValidator implements SRSSElement
{ {

12
src/Exception/InvalidPropertyException.php Normal file
View File

@ -0,0 +1,12 @@
<?php
namespace Shikiryu\SRSS\Exception;
class InvalidPropertyException extends SRSSException
{
public function __construct(string $object, string $property, ?string $value)
{
parent::__construct(sprintf('Invalid property `%s` = `%s` in `%s`', $property, $value, $object));
}
}

37
src/SRSS.php
View File

@ -11,6 +11,7 @@ use Shikiryu\SRSS\Entity\Channel\Cloud;
use Shikiryu\SRSS\Entity\Channel\Image; use Shikiryu\SRSS\Entity\Channel\Image;
use Shikiryu\SRSS\Entity\Item; use Shikiryu\SRSS\Entity\Item;
use Shikiryu\SRSS\Exception\ChannelNotFoundInRSSException; use Shikiryu\SRSS\Exception\ChannelNotFoundInRSSException;
use Shikiryu\SRSS\Exception\InvalidPropertyException;
use Shikiryu\SRSS\Exception\PropertyNotFoundException; use Shikiryu\SRSS\Exception\PropertyNotFoundException;
use Shikiryu\SRSS\Exception\SRSSException; use Shikiryu\SRSS\Exception\SRSSException;
use Shikiryu\SRSS\Exception\UnreadableRSSException; use Shikiryu\SRSS\Exception\UnreadableRSSException;
@ -27,17 +28,18 @@ use Shikiryu\SRSS\Validator\Validator;
* @property null|string $managingEditor * @property null|string $managingEditor
* @property null|string $webMaster * @property null|string $webMaster
* @property null|string $pubDate * @property null|string $pubDate
* @property null|string $lastBuildDate * @property null|string $lastBuildDate
* @property null|Category[] $category * @property null|Category[] $category
* @property null|string $generator * @property null|string $generator
* @property null|string $docs * @property null|string $docs
* @property null|Cloud $cloud * @property null|Cloud $cloud
* @property null|string $ttl * @property null|string $ttl
* @property null|Image $image * @property null|Image $image
* @property null|string $rating * @property null|string $rating
* @property null|string $textInput * @property null|string $textInput
* @property null|string $skipHours * @property null|string $skipHours
* @property null|string $skipDays * @property null|string $skipDays
* @property string|null $validated
*/ */
class SRSS implements Iterator class SRSS implements Iterator
{ {
@ -126,15 +128,16 @@ class SRSS implements Iterator
if (!property_exists(Channel::class, $name)) { if (!property_exists(Channel::class, $name)) {
throw new PropertyNotFoundException(Channel::class, $name); throw new PropertyNotFoundException(Channel::class, $name);
} }
if ((new Validator())->isValidValueForObjectProperty($this->channel, $name, $val)) {
if (SRSSTools::getPropertyType(Channel::class, $name) === 'array') { if (!(new Validator())->isValidValueForObjectProperty($this->channel, $name, $val)) {
$this->channel->{$name} = $val; throw new InvalidPropertyException(get_class($this), $name, $val);
} else { }
$val = is_string($val) ? (new Formator())->formatValue($this->channel, $name, $val) : $val;
$this->channel->{$name} = $val;
}
if (SRSSTools::getPropertyType(Channel::class, $name) === 'array') {
$this->channel->{$name} = $val;
} else {
$val = is_string($val) ? (new Formator())->formatValue($this->channel, $name, $val) : $val;
$this->channel->{$name} = $val;
} }
} }

21
src/Validator/HasValidator.php
View File

@ -2,6 +2,7 @@
namespace Shikiryu\SRSS\Validator; namespace Shikiryu\SRSS\Validator;
use Shikiryu\SRSS\Exception\InvalidPropertyException;
use Shikiryu\SRSS\Exception\PropertyNotFoundException; use Shikiryu\SRSS\Exception\PropertyNotFoundException;
use Shikiryu\SRSS\Exception\SRSSException; use Shikiryu\SRSS\Exception\SRSSException;
use Shikiryu\SRSS\SRSSTools; use Shikiryu\SRSS\SRSSTools;
@ -27,17 +28,19 @@ abstract class HasValidator
if (!property_exists(static::class, $name)) { if (!property_exists(static::class, $name)) {
throw new PropertyNotFoundException(static::class, $name); throw new PropertyNotFoundException(static::class, $name);
} }
if ((new Validator())->isValidValueForObjectProperty($this, $name, $val)) {
if (SRSSTools::getPropertyType(static::class, $name) === 'array') {
/** @var array $this->{$name} */
$this->{$name}[] = $val;
} else {
$val = is_string($val) ? (new Formator())->formatValue($this, $name, $val) : $val;
$this->{$name} = $val;
}
if (!(new Validator())->isValidValueForObjectProperty($this, $name, $val)) {
throw new InvalidPropertyException(get_class($this), $name, $val);
} }
if (SRSSTools::getPropertyType(static::class, $name) === 'array') {
/** @var array $this->{$name} */
$this->{$name}[] = $val;
} else {
$val = is_string($val) ? (new Formator())->formatValue($this, $name, $val) : $val;
$this->{$name} = $val;
}
} }
/** /**

19
src/Validator/Validator.php
View File

@ -24,6 +24,7 @@ class Validator
*/ */
public function isValidValueForObjectProperty($object, $property, $value): bool public function isValidValueForObjectProperty($object, $property, $value): bool
{ {
$this->object = $object;
try { try {
$property = $this->getReflectedProperty($object, $property); $property = $this->getReflectedProperty($object, $property);
} catch (ReflectionException) { } catch (ReflectionException) {
@ -31,17 +32,19 @@ class Validator
} }
$propertyAnnotations = $this->_getPropertyAnnotations($property); $propertyAnnotations = $this->_getPropertyAnnotations($property);
if (empty($value) && count(array_filter($property['rules'], static fn($rule) => str_starts_with($rule, 'required'))) === 0) { if (empty($value) && count(array_filter($propertyAnnotations, static fn($rule) => str_starts_with($rule, 'required'))) === 0) {
return true; return true;
} }
foreach ($propertyAnnotations as $propertyAnnotation) { foreach ($propertyAnnotations as $propertyAnnotation) {
$annotation = explode(' ', $propertyAnnotation); $annotation = explode(' ', $propertyAnnotation);
$object->validated[$property->name] = $this->_validateProperty($annotation, $value); if ($this->_validateProperty($annotation, $value) === false) {
return false;
}
} }
return count(array_filter($object->validated, static fn($v) => ($v !== null && $v === false))) === 0; return true;
} }
/** /**
@ -69,6 +72,7 @@ class Validator
*/ */
public function isObjectValid($object): bool public function isObjectValid($object): bool
{ {
$object->validated = [];
// if (!$object->validated) { // if (!$object->validated) {
$object = $this->validateObject($object); $object = $this->validateObject($object);
// } // }
@ -250,4 +254,13 @@ class Validator
{ {
return filter_var($value, FILTER_VALIDATE_EMAIL); return filter_var($value, FILTER_VALIDATE_EMAIL);
} }
private function _validateMax($value, array $max): bool
{
return $value <= current($max);
}
private function _validateMin($value, array $max): bool
{
return $value >= current($max);
}
} }

318
tests/FailingTest.php
View File

@ -1,114 +1,230 @@
<?php <?php
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
use Shikiryu\SRSS\Entity\Channel\Category;
use Shikiryu\SRSS\Entity\Channel\Cloud;
use Shikiryu\SRSS\Entity\Channel\Image;
use Shikiryu\SRSS\Entity\Item\Enclosure;
use Shikiryu\SRSS\Entity\Item\Source;
use Shikiryu\SRSS\Exception\InvalidPropertyException;
use Shikiryu\SRSS\SRSS; use Shikiryu\SRSS\SRSS;
class FailingTest extends TestCase class FailingTest extends TestCase
{ {
private ?SRSS $srss; public function testInvalidChannelMandatory(): void
public function testInvalidChannel()
{ {
$this->srss = SRSS::create(); $rss = SRSS::create();
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true)); self::assertFalse($rss->isValid(), var_export($rss->validated, true));
$this->srss->title = 'title'; // mandatory $rss->title = 'title'; // mandatory
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true)); self::assertFalse($rss->isValid(), var_export($rss->validated, true));
$this->srss->description = 'desc'; // mandatory $rss->description = 'desc'; // mandatory
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true)); self::assertFalse($rss->isValid(), var_export($rss->validated, true));
$rss->link = 'https://example.org';
$this->srss->link = 'desc'; // mandatory but should be a url self::assertTrue($rss->isValid(), var_export($rss->validated, true));
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->link = 'https://example.org';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->language = 'en-en'; // should be a valid language
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->language = 'en-us'; // should be a valid
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->copyright = '<strong>test</strong>'; // should not have html element
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->copyright = 'shikiryu';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->managingEditor = '<strong>test</strong>'; // should not have html element
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->managingEditor = 'shikiryu';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->webMaster = '<strong>test</strong>'; // should not have html element
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->webMaster = 'shikiryu';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->pubDate = 'test'; // should be a valid date
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->pubDate = (new DateTime())->format(DATE_RSS);
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->lastBuildDate = 'test'; // should be a valid date
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->lastBuildDate = (new DateTime())->format(DATE_RSS);
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->generator = '<strong>test</strong>'; // should not have html element
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->generator = 'shikiryuRSS';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->docs = 'desc'; //should be a url
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->docs = 'https://example.org';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->ttl = 'desc'; // should be an int
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->ttl = '85';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
// rating and textInput not tested because there's no validation
$this->srss->skipHours = 'desc'; // should be an hour
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->skipHours = '12';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->skipDays = 'desc'; // should be a day
self::assertFalse($this->srss->isValid(), var_export($this->srss->validated, true));
$this->srss->skipDays = 'monday';
self::assertTrue($this->srss->isValid(), var_export($this->srss->validated, true));
} }
public function testItem() public function testInvalidChannelLink(): void
{
$this->expectException(InvalidPropertyException::class);
$rss = SRSS::create();
$rss->title = 'title'; // mandatory
$rss->description = 'desc'; // mandatory
$rss->link = 'desc'; // mandatory but should be an url
}
public function testInvalidChannelLanguage(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->language = 'en-en'; // should be a valid language
}
public function testInvalidChannelCopyright(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->copyright = '<strong>test</strong>'; // should not have html element
}
public function testInvalidChannelManagingEditor(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->managingEditor = '<strong>test</strong>'; // should not have html element
}
public function testInvalidChannelWebmaster(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->webMaster = '<strong>test</strong>'; // should not have html element
}
public function testInvalidChannelPubDate(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->pubDate = 'test'; // should be a valid date
}
public function testInvalidChannelLastBuildDate(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->lastBuildDate = 'test'; // should be a valid date
}
public function testInvalidChannelGenerator(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->generator = '<strong>test</strong>'; // should not have html element
}
public function testInvalidChannelDocs(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->docs = 'desc'; //should be a url
}
public function testInvalidChannelTTL(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->ttl = 'desc'; // should be an int
}
public function testInvalidChannelSkipHours(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->skipHours = 'desc'; // should be an hour
}
public function testInvalidChannelSkipDays(): void
{
$rss = SRSS::create();
$this->expectException(InvalidPropertyException::class);
$rss->skipDays = 'desc'; // should be a day
}
public function testInvalidItemAuthor(): void
{ {
$item = new Shikiryu\SRSS\Entity\Item(); $item = new Shikiryu\SRSS\Entity\Item();
$this->expectException(InvalidPropertyException::class);
self::assertFalse($item->isValid(), var_export($item->validated, true)); $item->author = 'test'; // should be an email
$item->title = 'title';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->link = 'test';
self::assertFalse($item->isValid(), var_export($item->validated, true));
$item->link = 'https://example.org/link1';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->title = null;
self::assertFalse($item->isValid(), var_export($item->validated, true));
$item->description = 'desc';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->title = 'title';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->author = 'test';
self::assertFalse($item->isValid(), var_export($item->validated, true));
$item->author = 'email@example.org';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->comments = 'test';
self::assertFalse($item->isValid(), var_export($item->validated, true));
$item->comments = 'https://example.org/link1';
self::assertTrue($item->isValid(), var_export($item->validated, true));
// guid is not validated and, so, not tested
} }
}
public function testInvalidItemComments(): void
{
$item = new Shikiryu\SRSS\Entity\Item();
$this->expectException(InvalidPropertyException::class);
$item->comments = 'test'; // should be an url
}
public function testInvalidItemMandatory(): void
{
$item = new Shikiryu\SRSS\Entity\Item();
$item->title = 'title';
self::assertTrue($item->isValid(), var_export($item->validated, true));
$item->description = 'desc';
$item->title = null;
self::assertTrue($item->isValid(), var_export($item->validated, true));
$this->expectException(InvalidPropertyException::class);
$item->title = null;
$item->description = null;
}
public function testChannelCategoryDomain(): void
{
$category = new Category();
$this->expectException(InvalidPropertyException::class);
$category->domain = 'test';
}
public function testChannelCloudPort(): void
{
$cloud = new Cloud();
$this->expectException(InvalidPropertyException::class);
$cloud->port = 'test';
}
public function testChannelImageUrl(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->url = 'test';
}
public function testChannelImageTitle(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->title = '<strong>test</strong>';
}
public function testChannelImageLink(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->link = 'test';
}
public function testChannelImageWidthType(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->width = 'test';
}
public function testChannelImageWidthMax(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->width = '150';
}
public function testChannelImageHeightType(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->height = 'test';
}
public function testChannelImageHeightMax(): void
{
$image = new Image();
$this->expectException(InvalidPropertyException::class);
$image->height = '500';
}
public function testItemEnclosureUrl(): void
{
$enclosure = new Enclosure();
$this->expectException(InvalidPropertyException::class);
$enclosure->url = 'test';
}
public function testItemEnclosureLength(): void
{
$enclosure = new Enclosure();
$this->expectException(InvalidPropertyException::class);
$enclosure->length = 'test';
}
public function testItemSourceUrl()
{
$source = new Source();
$this->expectException(InvalidPropertyException::class);
$source->url = 'test';
}
public function testItemSourceValue()
{
$source = new Source();
$this->expectException(InvalidPropertyException::class);
$source->value = '<strong>test</strong>';
}
}