Skip to content

Commit faa664c

Browse files
IanDelMarIanDelMar
authored
Update Faker and use Faker in test data (#233)
1 parent 19596c3 commit faa664c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+356
-347
lines changed

‎tests/Faker.php‎

Lines changed: 68 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -5,71 +5,92 @@
55
namespace PhpStubs\WordPress\Core\Tests;
66

77
/**
8-
* @phpstan-type Types array{
9-
* bool: bool,
10-
* int: int,
11-
* float: float,
12-
* string: string,
13-
* array: array<mixed>,
14-
* resource: resource,
15-
* object: object,
16-
* numeric-string: numeric-string,
17-
* null: null,
18-
* mixed: mixed,
19-
* true: true,
20-
* false: false,
21-
* callable: callable,
22-
* iterable: iterable<mixed>,
23-
* array-key: array-key,
24-
* positive-int: positive-int,
25-
* negative-int: negative-int,
26-
* non-positive-int: non-positive-int,
27-
* non-negative-int: non-negative-int,
28-
* non-zero-int: non-zero-int,
29-
* }
8+
* Class that provides fake types via docBlocks for type testing.
9+
*
10+
* @method static bool bool()
11+
* @method static true true()
12+
* @method static false false()
13+
* @method static int int()
14+
* @method static positive-int positiveInt()
15+
* @method static negative-int negativeInt()
16+
* @method static non-positive-int nonPositiveInt()
17+
* @method static non-negative-int nonNegativeInt()
18+
* @method static non-zero-int nonZeroInt()
19+
* @method static float float()
20+
* @method static string string()
21+
* @method static non-empty-string nonEmptyString()
22+
* @method static numeric-string numericString()
23+
* @method static resource resource()
24+
* @method static object object()
25+
* @method static mixed mixed()
26+
* @method static callable callable()
27+
* @method static \stdClass stdClass()
28+
* @method static \WP_Post wpPost()
29+
* @method static \WP_Term wpTerm()
30+
* @method static \WP_Comment wpComment()
31+
* @method static \WP_REST_Request wpRestRequest()
32+
* @method static \WP_Theme wpTheme()
33+
* @method static \WP_Translations wpTranslations()
34+
* @method static \WP_Query wpQuery()
35+
* @method static \WP_Widget_Factory wpWidgetFactory()
3036
*/
3137
class Faker
3238
{
3339
/**
34-
* @var Types $types
35-
* @phpstan-ignore-next-line
40+
* Fakes `array<Type>`. If `$type` is `null`, fakes `array<mixed>`.
41+
*
42+
* @template T
43+
* @param T $type
44+
* @return ($type is null ? array<array-key, mixed> : array<array-key, T>)
3645
*/
37-
private static $types;
46+
public static function array($type = null): array
47+
{
48+
return [$type];
49+
}
3850

3951
/**
40-
* @template T of string
41-
* @param T $type
42-
* @return Types[T]
52+
* Fakes `array<int, Type>`. If `$type` is `null`, fakes `array<int, mixed>`.
53+
*
54+
* @template T
55+
* @param T|null $type
56+
* @return ($type is null ? array<int, mixed> : array<int, T>)
57+
*/
58+
public static function intArray($type = null): array
59+
{
60+
return [$type];
61+
}
62+
63+
/**
64+
* Fakes `array<string, Type>`. If `$type` is `null`, fakes `array<string, mixed>`.
65+
*
66+
* @template T
67+
* @param T|null $type
68+
* @return ($type is null ? array<string, mixed>: array<string, T>)
4369
*/
44-
public static function fake(string $type): mixed
70+
public static function strArray($type = null): array
4571
{
46-
return self::$types[$type];
72+
return [self::string() => $type];
4773
}
4874

4975
/**
50-
* @template T of string
51-
* @template K of string
52-
* @param T $valueType
53-
* @param K $keyType
54-
* @return array<Types[K], Types[T]>
76+
* Fakes `list<Type>`. If `$type` is `null`, fakes `list<mixed>`.
77+
*
78+
* @template T
79+
* @param T|null $type
80+
* @return ($type is null ? list<mixed> : list<T>)
5581
*/
56-
public static function fakeArray(string $valueType, string $keyType = 'array-key'): mixed
82+
public static function list($type = null): array
5783
{
58-
return [$_GET[$keyType], $_GET[$valueType]];
84+
return [$type];
5985
}
6086

6187
/**
62-
* @template T of non-empty-array<key-of<Types>>
63-
* @param T $types
64-
* @return Types[value-of<T>]
88+
* @template T
89+
* @param T ...$types
90+
* @return T
6591
*/
66-
public static function or(array $types): mixed
92+
public static function union(...$types): mixed
6793
{
68-
foreach ($types as $type) {
69-
if ($_GET['thing'] === $type) {
70-
return self::fake($type);
71-
}
72-
}
73-
return self::fake($types[0]);
94+
return $types[0];
7495
}
7596
}

‎tests/TypeInferenceTest.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ public function dataFileAsserts(): iterable
1616
yield from $this->gatherAssertTypes(__DIR__ . '/data/bool_from_yn.php');
1717
yield from $this->gatherAssertTypes(__DIR__ . '/data/current_time.php');
1818
yield from $this->gatherAssertTypes(__DIR__ . '/data/echo_parameter.php');
19+
yield from $this->gatherAssertTypes(__DIR__ . '/data/Faker.php');
1920
yield from $this->gatherAssertTypes(__DIR__ . '/data/get_approved_comments.php');
2021
yield from $this->gatherAssertTypes(__DIR__ . '/data/get_attachment_taxonomies.php');
2122
yield from $this->gatherAssertTypes(__DIR__ . '/data/get_bookmark.php');

‎tests/data/Faker.php‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace PhpStubs\WordPress\Core\Tests;
6+
7+
use function PHPStan\Testing\assertType;
8+
9+
// Boleans
10+
assertType('bool', Faker::bool());
11+
assertType('true', Faker::true());
12+
assertType('false', Faker::false());
13+
14+
// Numbers
15+
assertType('int', Faker::int());
16+
assertType('int<1, max>', Faker::positiveInt());
17+
assertType('int<min, -1>', Faker::negativeInt());
18+
assertType('int<min, 0>', Faker::nonPositiveInt());
19+
assertType('int<0, max>', Faker::nonNegativeInt());
20+
assertType('int<min, -1>|int<1, max>', Faker::nonZeroInt());
21+
assertType('float', Faker::float());
22+
23+
// Strings
24+
assertType('string', Faker::string());
25+
assertType('numeric-string', Faker::numericString());
26+
assertType('non-empty-string', Faker::nonEmptyString());
27+
28+
// Arrays with default values
29+
assertType('array', Faker::array());
30+
assertType('array<int, mixed>', Faker::intArray());
31+
assertType('array<string, mixed>', Faker::strArray());
32+
assertType('list<mixed>', Faker::list());
33+
34+
// Arrays with specific values
35+
assertType('array<int>', Faker::array(Faker::int()));
36+
assertType('array<int, string>', Faker::intArray(Faker::string()));
37+
assertType('array<string, bool>', Faker::strArray(Faker::bool()));
38+
assertType('list<mixed>', Faker::list());
39+
40+
// Unions
41+
assertType('bool', Faker::union(Faker::bool()));
42+
assertType('bool|int', Faker::union(Faker::bool(), Faker::int()));
43+
assertType('bool|int|string', Faker::union(Faker::bool(), Faker::int(), Faker::string()));
44+
assertType('array<int, int>|bool|int|string', Faker::union(Faker::bool(), Faker::int(), Faker::string(), Faker::intArray(Faker::int())));
45+
assertType('array<int|string, int|string>', Faker::union(Faker::intArray(Faker::int()), Faker::strArray(Faker::string())));
46+
assertType('array<int|string>', Faker::union(Faker::array(Faker::int()), Faker::strArray(Faker::string())));
47+
assertType('array', Faker::union(Faker::array(), Faker::strArray()));
48+
assertType('array', Faker::union(Faker::array(), Faker::intArray()));
49+
assertType('string|null', Faker::union(Faker::string(), null));
50+
51+
// Other
52+
assertType('resource', Faker::resource());
53+
assertType('object', Faker::object());
54+
assertType('stdClass', Faker::stdClass());
55+
assertType('WP_Post', Faker::wpPost());
56+
assertType('WP_Term', Faker::wpTerm());
57+
assertType('WP_Comment', Faker::wpComment());
58+
assertType('WP_REST_Request', Faker::wpRestRequest());
59+
assertType('WP_Theme', Faker::wpTheme());
60+
assertType('WP_Translations', Faker::wpTranslations());
61+
assertType('WP_Query', Faker::wpQuery());
62+
assertType('WP_Widget_Factory', Faker::wpWidgetFactory());
63+
assertType('mixed', Faker::mixed());

‎tests/data/_wp_json_sanity_check.php‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@
44

55
namespace PhpStubs\WordPress\Core\Tests;
66

7-
use stdClass;
8-
97
use function PHPStan\Testing\assertType;
108
use function _wp_json_sanity_check;
119

1210
assertType('null', _wp_json_sanity_check(null, 1));
13-
assertType('bool', _wp_json_sanity_check((bool)$_GET['value'], 1));
14-
assertType('int', _wp_json_sanity_check((int)$_GET['value'], 1));
15-
assertType('string', _wp_json_sanity_check((string)$_GET['value'], 1));
16-
assertType('array', _wp_json_sanity_check((array)$_GET['value'], 1));
17-
assertType('stdClass', _wp_json_sanity_check(new stdClass(), 1));
18-
assertType('mixed', _wp_json_sanity_check($_GET['value'], 1));
11+
assertType('bool', _wp_json_sanity_check(Faker::bool(), 1));
12+
assertType('int', _wp_json_sanity_check(Faker::int(), 1));
13+
assertType('string', _wp_json_sanity_check(Faker::string(), 1));
14+
assertType('array', _wp_json_sanity_check(Faker::array(), 1));
15+
assertType('stdClass', _wp_json_sanity_check(Faker::stdClass(), 1));
16+
assertType('mixed', _wp_json_sanity_check(Faker::mixed(), 1));

‎tests/data/absint.php‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,15 @@
44

55
namespace PhpStubs\WordPress\Core\Tests;
66

7-
use stdClass;
8-
97
use function absint;
108
use function PHPStan\Testing\assertType;
119

12-
/** @var int<1, max> $posInt */
13-
$posInt = $_GET['posInt'];
14-
15-
/** @var int<0, max> $nonNegInt */
16-
$nonNegInt = $_GET['nonNegInt'];
17-
18-
/** @var resource $resource */
19-
$resource = $_GET['resource'];
20-
2110
// Returns input for non-negative integers
2211
assertType('0', absint(0));
2312
assertType('1', absint(1));
2413
assertType('10', absint(10));
25-
assertType('int<1, max>', absint($posInt));
26-
assertType('int<0, max>', absint($nonNegInt));
14+
assertType('int<1, max>', absint(Faker::positiveInt()));
15+
assertType('int<0, max>', absint(Faker::nonNegativeInt()));
2716

2817
// Returns 0 for "empty" input
2918
assertType('0', absint(null));
@@ -40,15 +29,17 @@
4029
assertType('1', absint(['key' => 'value']));
4130

4231
// Returns 0 or 1 for booleans
43-
assertType('0|1', absint((bool)$_GET['bool']));
32+
assertType('0|1', absint(Faker::bool()));
4433

4534
// Returns positive integer for strictly negative integer input
4635
assertType('int<1, max>', absint(-1));
4736
assertType('int<1, max>', absint(-10));
4837

4938
// Returns non-negative integer for floats, numeric strings, ressources
5039
assertType('int<0, max>', absint(1.0));
40+
assertType('int<0, max>', absint(Faker::float()));
5141
assertType('int<0, max>', absint('-10'));
52-
assertType('int<0, max>', absint($resource));
42+
assertType('int<0, max>', absint(Faker::numericString()));
43+
assertType('int<0, max>', absint(Faker::resource()));
5344
// and any other type that is not a subtype of `$maybeint`
54-
assertType('int<0, max>', absint(new stdClass()));
45+
assertType('int<0, max>', absint(Faker::stdClass()));

‎tests/data/bool_from_yn.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
assertType('true', bool_from_yn('y'));
1111
assertType('false', bool_from_yn('n'));
1212
assertType('false', bool_from_yn('thing'));
13-
assertType('bool', bool_from_yn((string)$_GET['string']));
13+
assertType('bool', bool_from_yn(Faker::string()));

‎tests/data/current_time.php‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,4 @@
1414
// String types
1515
assertType('string', current_time('mysql'));
1616
assertType('string', current_time('Hello'));
17-
18-
// Unknown string
19-
assertType('int|string', current_time((string)$_GET['unknown_string']));
17+
assertType('int|string', current_time(Faker::string()));

‎tests/data/echo_parameter.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@
8383
assertType('string', wp_register('', '', $value));
8484
assertType('string', wp_title('', $value));
8585

86-
// Unknown value
87-
$value = isset($_GET['foo']);
86+
// Unknown boolean value
87+
$value = Faker::bool();
8888
assertType('string|null', comment_class('', null, null, $value));
8989
assertType('string|null', edit_term_link('', '', '', null, $value));
9090
assertType('string|null', get_calendar(true, $value));

‎tests/data/get_attachment_taxonomies.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@
88
use function PHPStan\Testing\assertType;
99

1010
// Default
11-
assertType('array<int, string>', get_attachment_taxonomies((int)$_GET['id']));
12-
assertType('array<int, string>', get_attachment_taxonomies((int)$_GET['id'], 'names'));
11+
assertType('array<int, string>', get_attachment_taxonomies(Faker::int()));
12+
assertType('array<int, string>', get_attachment_taxonomies(Faker::int(), 'names'));
1313

1414
// Objects
15-
assertType('array<string, WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], 'objects'));
15+
assertType('array<string, WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), 'objects'));
1616

1717
// Unexpected
18-
assertType('array<string, WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], 'Hello'));
18+
assertType('array<string, WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), 'Hello'));
1919

2020
// Unknown
21-
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], (string)$_GET['string']));
21+
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), Faker::string()));
2222

2323
// Unions
24-
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], $_GET['foo'] ? 'names' : 'objects'));
25-
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], $_GET['foo'] ? (string)$_GET['string'] : 'names'));
26-
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies((int)$_GET['id'], $_GET['foo'] ? (string)$_GET['string'] : 'objects'));
24+
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), Faker::bool() ? 'names' : 'objects'));
25+
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), Faker::bool() ? Faker::string() : 'names'));
26+
assertType('array<int|string, string|WP_Taxonomy>', get_attachment_taxonomies(Faker::int(), Faker::bool() ? Faker::string() : 'objects'));

‎tests/data/get_bookmark.php‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
use function get_bookmark;
88
use function PHPStan\Testing\assertType;
99

10-
/** @var \stdClass|int $bookmark */
11-
$bookmark = $_GET['bookmark'];
10+
$stdClassOrInt = Faker::union(Faker::stdClass(), Faker::int());
1211

13-
assertType('stdClass|null', get_bookmark($bookmark));
14-
assertType('stdClass|null', get_bookmark($bookmark, 'OBJECT'));
15-
assertType('array<string, mixed>|null', get_bookmark($bookmark, 'ARRAY_A'));
16-
assertType('array<int, mixed>|null', get_bookmark($bookmark, 'ARRAY_N'));
12+
assertType('stdClass|null', get_bookmark($stdClassOrInt));
13+
assertType('stdClass|null', get_bookmark($stdClassOrInt, 'OBJECT'));
14+
assertType('array<string, mixed>|null', get_bookmark($stdClassOrInt, 'ARRAY_A'));
15+
assertType('array<int, mixed>|null', get_bookmark($stdClassOrInt, 'ARRAY_N'));

0 commit comments

Comments
 (0)