Mirrors/wiosna-dev_common-library
1
0
Fork 1
mirror of https://github.com/wiosna-dev/common-library.git synced 2026-03-12 09:31:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename Collection class to BaseCollection. Add BaseCollection::isValidType() method to validate type of element before add it to collection. Add BaseCollection ::prepareElements() method to allow preparation of elements in custom way.

Browse Source
This commit is contained in:
Meritoo
2019-09-18 14:51:09 +02:00
parent b91606ada9
commit a7c39b26ba
17 changed files with 627 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
tests/Collection/CollectionTest.php → tests/Collection/BaseCollectionTest.php
View File

@@ -10,9 +10,12 @@ namespace Meritoo\Test\Common\Collection;
use ArrayIterator;
use Generator;
use Meritoo\Common\Collection\Collection;
use Meritoo\Common\Collection\BaseCollection;
use Meritoo\Common\Collection\DateTimeCollection;
use Meritoo\Common\Collection\StringCollection;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
use Meritoo\Test\Common\Collection\Collection\ArrayCollection;
use ReflectionClass;
/**
@@ -22,21 +25,21 @@ use ReflectionClass;
* @copyright Meritoo <http://www.meritoo.pl>
*
* @internal
* @covers \Meritoo\Common\Collection\Collection
* @covers \Meritoo\Common\Collection\BaseCollection
*/
class CollectionTest extends BaseTestCase
class BaseCollectionTest extends BaseTestCase
{
/**
* An empty collection
*
* @var Collection
* @var StringCollection
*/
private $emptyCollection;
/**
* Simple collection
*
* @var Collection
* @var StringCollection
*/
private $simpleCollection;
@@ -135,14 +138,14 @@ class CollectionTest extends BaseTestCase
}
/**
* @param mixed $element The element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param Collection $collection The collection
* @param mixed $element The element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param BaseCollection $collection The collection
*
* @dataProvider provideElementToAdd
*/
public function testAddWithoutIndex($element, $expectedCount, $expectedIndex, Collection $collection)
public function testAddWithoutIndex($element, $expectedCount, $expectedIndex, BaseCollection $collection)
{
$collection->add($element);
@@ -152,15 +155,15 @@ class CollectionTest extends BaseTestCase
}
/**
* @param mixed $element The element to add
* @param mixed $index Index of element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param Collection $collection The collection
* @param mixed $element The element to add
* @param mixed $index Index of element to add
* @param int $expectedCount Expected count of elements in collection
* @param int $expectedIndex Expected index of added element in collection
* @param BaseCollection $collection The collection
*
* @dataProvider provideElementToAddWithIndex
*/
public function testAddWithIndex($element, $index, $expectedCount, $expectedIndex, Collection $collection)
public function testAddWithIndex($element, $index, $expectedCount, $expectedIndex, BaseCollection $collection)
{
$collection->add($element, $index);
@@ -328,7 +331,7 @@ class CollectionTest extends BaseTestCase
public function testExistsVisibilityAndArguments()
{
$reflectionClass = new ReflectionClass(Collection::class);
$reflectionClass = new ReflectionClass(BaseCollection::class);
$method = $reflectionClass->getMethod('exists');
static::assertMethodVisibility($method, OopVisibilityType::IS_PRIVATE);
@@ -336,18 +339,31 @@ class CollectionTest extends BaseTestCase
}
/**
* @param string $description Description of test
* @param Collection $collection Collection to search for element with given index
* @param mixed $index Index / key of the element
* @param mixed $expected Expected element with given index
* @param string $description Description of test
* @param BaseCollection $collection Collection to search for element with given index
* @param mixed $index Index / key of the element
* @param mixed $expected Expected element with given index
*
* @dataProvider provideElementGetByIndex
*/
public function testGetByIndex($description, Collection $collection, $index, $expected)
public function testGetByIndex($description, BaseCollection $collection, $index, $expected)
{
static::assertEquals($expected, $collection->getByIndex($index), $description);
}
/**
* @param string $description
* @param array $elements
* @param array $expected
*
* @dataProvider provideElementsToValidateType
*/
public function testGetElementsWithValidType(string $description, array $elements, array $expected): void
{
$collection = new ArrayCollection($elements);
static::assertSame($expected, $collection->toArray(), $description);
}
/**
* Provides element to add to collection
*
@@ -359,14 +375,14 @@ class CollectionTest extends BaseTestCase
'This is test 1',
1,
0,
new Collection(),
new StringCollection(),
];
yield[
'This is test 2',
2,
1,
new Collection([
new StringCollection([
'I am 1st',
]),
];
@@ -375,7 +391,7 @@ class CollectionTest extends BaseTestCase
'This is test 3',
3,
2,
new Collection([
new StringCollection([
'I am 1st',
'I am 2nd',
]),
@@ -394,7 +410,7 @@ class CollectionTest extends BaseTestCase
'test1',
1,
'test1',
new Collection(),
new StringCollection(),
];
yield[
@@ -402,7 +418,7 @@ class CollectionTest extends BaseTestCase
'test2',
2,
'test2',
new Collection([
new StringCollection([
'test1' => 'I am 1st',
]),
];
@@ -412,7 +428,7 @@ class CollectionTest extends BaseTestCase
null,
3,
0,
new Collection([
new StringCollection([
'test1' => 'I am 1st',
'test2' => 'I am 2nd',
]),
@@ -423,7 +439,7 @@ class CollectionTest extends BaseTestCase
'',
4,
1,
new Collection([
new StringCollection([
'test1' => 'I am 1st',
'test2' => 'I am 2nd',
'I am 3rd',
@@ -435,7 +451,7 @@ class CollectionTest extends BaseTestCase
'test5',
5,
'test5',
new Collection([
new StringCollection([
'test1' => 'I am 1st',
'test2' => 'I am 2nd',
2 => 'I am 3rd',
@@ -448,7 +464,7 @@ class CollectionTest extends BaseTestCase
'test2',
4,
'test2',
new Collection([
new StringCollection([
'test1' => 'I am 1st',
'test2' => 'I am 2nd',
2 => 'I am 3rd',
@@ -461,21 +477,21 @@ class CollectionTest extends BaseTestCase
{
yield[
'An empty collection and empty index',
new Collection(),
new StringCollection(),
'',
null,
];
yield[
'An empty collection and non-empty index',
new Collection(),
new StringCollection(),
'test',
null,
];
yield[
'Non-empty collection and not existing index',
new Collection([
new StringCollection([
'lorem' => 'ipsum',
'dolor' => 'sit',
]),
@@ -485,7 +501,7 @@ class CollectionTest extends BaseTestCase
yield[
'Collection with existing index',
new Collection([
new StringCollection([
'lorem' => 'ipsum',
'dolor' => 'sit',
]),
@@ -495,7 +511,7 @@ class CollectionTest extends BaseTestCase
yield[
'Collection with existing index (collection of arrays)',
new Collection([
new ArrayCollection([
[
'lorem',
'ipsum',
@@ -514,7 +530,7 @@ class CollectionTest extends BaseTestCase
yield[
'Collection with existing index (collection of objects)',
new Collection([
new DateTimeCollection([
'x' => new \DateTime(),
'y' => new \DateTime('2001-01-01'),
'z' => new \DateTime('yesterday'),
@@ -524,6 +540,56 @@ class CollectionTest extends BaseTestCase
];
}
public function provideElementsToValidateType(): ?Generator
{
yield[
'An empty array',
[],
[],
];
yield[
'Valid elements only',
[
[],
[
'123',
456,
],
],
[
[],
[
'123',
456,
],
],
];
yield[
'Mixed elements',
[
1,
'test',
'',
[],
234,
'test',
[
'123',
456,
],
],
[
3 => [],
6 => [
'123',
456,
],
],
];
}
/**
* {@inheritdoc}
*/
@@ -538,7 +604,7 @@ class CollectionTest extends BaseTestCase
345 => 'sit',
];
$this->emptyCollection = new Collection();
$this->simpleCollection = new Collection($this->simpleElements);
$this->emptyCollection = new StringCollection();
$this->simpleCollection = new StringCollection($this->simpleElements);
}
}

30
tests/Collection/Collection/ArrayCollection.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
/**
* (c) Meritoo.pl, http://www.meritoo.pl
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Test\Common\Collection\Collection;
use Meritoo\Common\Collection\BaseCollection;
/**
* Collection of arrays
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*
* @internal
* @coversNothing
*/
class ArrayCollection extends BaseCollection
{
protected function isValidType($element): bool
{
return is_array($element);
}
}

86
tests/Collection/DateTimeCollectionTest.php Normal file
View File

@@ -0,0 +1,86 @@
<?php
declare(strict_types=1);
namespace Meritoo\Test\Common\Collection;
use DateTime;
use Generator;
use Meritoo\Common\Collection\DateTimeCollection;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
/**
* Test case of the collection of DateTime instances
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*
* @internal
* @covers \Meritoo\Common\Collection\DateTimeCollection
*/
class DateTimeCollectionTest extends BaseTestCase
{
public function testConstructor(): void
{
static::assertConstructorVisibilityAndArguments(
DateTimeCollection::class,
OopVisibilityType::IS_PUBLIC,
1
);
}
/**
* @param string $description
* @param array $elements
* @param array $expectedElements
*
* @dataProvider provideDifferentTypesOfElements
*/
public function testCreateWithDifferentTypesOfElements(
string $description,
array $elements,
array $expectedElements
): void {
$collection = new DateTimeCollection($elements);
static::assertEquals($expectedElements, $collection->toArray(), $description);
}
public function provideDifferentTypesOfElements(): ?Generator
{
yield[
'An empty array',
[],
[],
];
yield[
'Valid elements only',
[
new DateTime('2001-01-01'),
new DateTime('2001-01-02'),
],
[
new DateTime('2001-01-01'),
new DateTime('2001-01-02'),
],
];
yield[
'Mixed elements',
[
1,
'test',
new DateTime('2001-01-01'),
'',
[],
234,
new DateTime('2001-01-02'),
],
[
2 => new DateTime('2001-01-01'),
6 => new DateTime('2001-01-02'),
],
];
}
}

85
tests/Collection/IntegerCollectionTest.php Normal file
View File

@@ -0,0 +1,85 @@
<?php
declare(strict_types=1);
namespace Meritoo\Test\Common\Collection;
use Meritoo\Common\Collection\IntegerCollection;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
/**
* Test case of the collection of integers
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*
* @internal
* @covers \Meritoo\Common\Collection\IntegerCollection
*/
class IntegerCollectionTest extends BaseTestCase
{
public function testConstructor(): void
{
static::assertConstructorVisibilityAndArguments(
IntegerCollection::class,
OopVisibilityType::IS_PUBLIC,
1
);
}
/**
* @param string $description
* @param array $elements
* @param array $expectedElements
*
* @dataProvider provideDifferentTypesOfElements
*/
public function testCreateWithDifferentTypesOfElements(
string $description,
array $elements,
array $expectedElements
): void {
$collection = new IntegerCollection($elements);
static::assertSame($expectedElements, $collection->toArray(), $description);
}
public function provideDifferentTypesOfElements(): ?\Generator
{
yield[
'An empty array',
[],
[],
];
yield[
'Valid elements only',
[
1,
2,
3,
],
[
1,
2,
3,
],
];
yield[
'Mixed elements',
[
1,
'test',
'',
[],
234,
'test',
],
[
0 => 1,
4 => 234,
],
];
}
}

86
tests/Collection/StringCollectionTest.php Normal file
View File

@@ -0,0 +1,86 @@
<?php
declare(strict_types=1);
namespace Meritoo\Test\Common\Collection;
use Meritoo\Common\Collection\StringCollection;
use Meritoo\Common\Test\Base\BaseTestCase;
use Meritoo\Common\Type\OopVisibilityType;
/**
* Test case of the collection of strings
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*
* @internal
* @covers \Meritoo\Common\Collection\StringCollection
*/
class StringCollectionTest extends BaseTestCase
{
public function testConstructor(): void
{
static::assertConstructorVisibilityAndArguments(
StringCollection::class,
OopVisibilityType::IS_PUBLIC,
1
);
}
/**
* @param string $description
* @param array $elements
* @param array $expectedElements
*
* @dataProvider provideDifferentTypesOfElements
*/
public function testCreateWithDifferentTypesOfElements(
string $description,
array $elements,
array $expectedElements
): void {
$collection = new StringCollection($elements);
static::assertSame($expectedElements, $collection->toArray(), $description);
}
public function provideDifferentTypesOfElements(): ?\Generator
{
yield[
'An empty array',
[],
[],
];
yield[
'Valid elements only',
[
'1',
'test',
'',
],
[
'1',
'test',
'',
],
];
yield[
'Mixed elements',
[
1,
'test',
'',
[],
234,
'test',
],
[
1 => 'test',
2 => '',
5 => 'test',
],
];
}
}