psalm-plugin-laravel/tests/acceptance/CollectionTypes.feature

152 lines
4.0 KiB
Gherkin
Raw Normal View History

2020-04-12 00:30:37 +02:00
Feature: collection types
Illuminate\Support\Collection has type support
Background:
Given I have the following config
"""
<?xml version="1.0"?>
<psalm totallyTyped="true">
<projectFiles>
<directory name="."/>
<ignoreFiles> <directory name="../../vendor"/> </ignoreFiles>
</projectFiles>
<plugins>
<pluginClass class="Psalm\LaravelPlugin\Plugin"/>
</plugins>
</psalm>
"""
Scenario:
Given I have the following code
"""
<?php declare(strict_types=1);
use Illuminate\Support\Collection;
final class CollectionTypes
{
/**
* @return Collection<int, string>
*/
public function getCollection(): Collection
{
return new Collection(['hi']);
}
public function popTest(): ?string
{
return $this->getCollection()->pop();
}
public function firstTest(): ?string
{
return $this->getCollection()->first(function (string $item) {
return strlen($item) > 3;
});
}
/**
* @return Collection<string, int>
*/
public function testFlip(): Collection
{
return $this->getCollection()->flip();
}
public function lastTest(): ?string
{
return $this->getCollection()->last(function (string $item) {
return strlen($item) > 3;
});
}
public function getTest(): ?string
{
return $this->getCollection()->get(function (string $item) {
return strlen($item) > 3;
});
}
public function pullTest(): ?string
{
return $this->getCollection()->pull(function (string $item) {
return strlen($item) > 3;
});
}
/**
* @return int|false
*/
public function searchTest()
{
return $this->getCollection()->search(function (string $item) {
return strlen($item) > 3;
});
}
public function shiftTest(): ?string
{
return $this->getCollection()->shift();
}
/**
* @return array<int, string>
*/
public function allTest(): array
{
return $this->getCollection()->all();
}
/**
* @return Collection<int, string>
*/
public function putTest(): Collection
{
return $this->getCollection()->put(5, 'five');
}
}
"""
When I run Psalm
Then I see no errors
Scenario:
Given I have the following code
"""
<?php declare(strict_types=1);
use Illuminate\Support\Collection;
final class CollectionTypes
{
/**
* @return Collection<int, string>
*/
public function getCollection(): Collection
{
return new Collection(['hi']);
}
public function failingTest(): bool
{
return $this->getCollection()->pop();
}
/**
* @return Collection<int, string>
*/
public function failingPut(): Collection
{
return $this->getCollection()->put(1, 2);
}
}
"""
When I run Psalm
Then I see these errors
| Type | Message |
| InvalidReturnType | The declared return type 'bool' for CollectionTypes::failingTest is incorrect, got 'null\|string' |
2020-04-12 23:54:43 +02:00
| NullableReturnStatement | The declared return type 'bool' for CollectionTypes::failingTest is not nullable, but the function returns 'null\|string' |
2020-04-12 00:30:37 +02:00
| InvalidReturnStatement | The inferred type 'null\|string' does not match the declared return type 'bool' for CollectionTypes::failingTest |
| InvalidScalarArgument | Argument 2 of Illuminate\Support\Collection::put expects string, int(2) provided |
And I see no other errors