Skip to content

Initialise hasNext() to false if the initial collection is empty/null #153

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

Merged
Ndiritu merged 3 commits into from
Nov 27, 2023
Merged

Initialise hasNext() to false if the initial collection is empty/null #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d73490
Remove null as possible type in PHPDoc since it causes an InvalidArgu…
Ndiritu Nov 23, 2023
0013cd5
Initialise hasNext to false if the initial collection is empty/null
Ndiritu Nov 23, 2023
abed5ba
Fix PHPStan failures
Ndiritu Nov 23, 2023
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
8 changes: 4 additions & 4 deletions src/Tasks/PageIterator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class PageIterator
private ?array $requestOptions = [];

/**
* @param Parsable|array<mixed>|object|null $response paged collection response
* @param Parsable|array<mixed>|object $response paged collection response
* @param RequestAdapter $requestAdapter
* @param array{class-string<T>,string}|null $constructorCallable
* The method to construct a paged response object.
Expand All @@ -57,7 +57,7 @@ public function __construct($response, RequestAdapter $requestAdapter, ?array $c

if ($page !== null) {
$this->currentPage = $page;
$this->hasNext = true;
$this->hasNext = !empty($page->getValue());
}
}

Expand Down Expand Up @@ -124,7 +124,7 @@ public function next(): ?PageResult
}

/**
* @param object|array<mixed>|null $response
* @param object|array<mixed>|Parsable|null $response
* @return PageResult|null
* @throws JsonException
*/
Expand All @@ -137,7 +137,7 @@ public static function convertToPage($response): ?PageResult

$value = null;
if (is_array($response)) {
$value = $response['value'] ?? ['value' => []];
$value = $response['value'] ?? [];
} elseif ($response instanceof Parsable &&
method_exists($response, 'getValue')) {
$value = $response->getValue();
Expand Down
43 changes: 43 additions & 0 deletions tests/Tasks/PageIteratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,4 +224,47 @@ public function testCanGetFromParsablePageObject(): void
$this->assertEquals(2, $count);
$this->assertInstanceOf(User::class, $data[0]);
}

public function testHasNextIsFalseWithEmptyOrNullInitialCollection(): void
{
$pageIterator = new PageIterator([], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator([1, 2, 3], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator(['value' => []], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator(['value' => null], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator((object) [], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator((object) [1, 2], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$pageIterator = new PageIterator((object) [], $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());

$usersResponse = new UsersResponse();
$usersResponse->setValue([]);
$pageIterator = new PageIterator($usersResponse, $this->mockRequestAdapter);
$this->assertFalse($pageIterator->hasNext());
}

public function testHasNextInitialisedToTrueWhenValueHasItems(): void
{
$pageIterator = new PageIterator(['value' => [1, 2, 3]], $this->mockRequestAdapter);
$this->assertTrue($pageIterator->hasNext());

$pageIterator = new PageIterator((object) ['value' => [1]], $this->mockRequestAdapter);
$this->assertTrue($pageIterator->hasNext());

$usersResponse = new UsersResponse();
$usersResponse->setValue([1, 2]);
$pageIterator = new PageIterator($usersResponse, $this->mockRequestAdapter);
$this->assertTrue($pageIterator->hasNext());
}
}