Skip to content

Commit 8d96dbe

Browse files
ildyriaildyria
authored
Working torwards scricter types. (#16)
1 parent 7fa2a77 commit 8d96dbe

17 files changed

+842
-312
lines changed

‎.github/workflows/CI.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ jobs:
1919
if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
2020
steps:
2121
- name: Cancel Previous Runs
22-
uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # 0.12.1
23-
with:
24-
access_token: ${{ github.token }}
22+
uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # 0.12.1
23+
with:
24+
access_token: ${{ github.token }}
2525

2626
php_syntax_errors:
2727
name: 1️⃣ PHP - Syntax errors

‎phpstan-baseline.neon

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
parameters:
2+
ignoreErrors:
3+
4+
-
5+
message: '#^Call to an undefined method Kalnoy\\Nestedset\\Contracts\\NodeQueryBuilder\<Tmodel of Illuminate\\Database\\Eloquent\\Model\>\:\:whereIn\(\)\.$#'
6+
identifier: method.notFound
7+
count: 1
8+
path: src/QueryBuilder.php
9+
10+
-
11+
message: '#^Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder\<Tmodel of Illuminate\\Database\\Eloquent\\Model\>\:\:whereRaw\(\)\.$#'
12+
identifier: staticMethod.dynamicCall
13+
count: 1
14+
path: src/QueryBuilder.php
15+

‎phpstan.neon

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
includes:
22
- vendor/larastan/larastan/extension.neon
33
- vendor/lychee-org/phpstan-lychee/phpstan.neon
4+
- phpstan-baseline.neon
45

56
parameters:
6-
level: 3
7+
level: 6
78
paths:
89
- src
10+
- tests/models/
911
excludePaths:
1012
stubFiles:
1113
ignoreErrors:
12-
# - identifier: missingType.generics
13-
- '#Interface must be located in "Contract" or "Contracts" namespace#'
14-
- '#Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder<.*>::select\(\).#'
15-
- '#Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder<.*>::from\(\).#'
16-
# - '#Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder<.*>::whereRaw\(\).#'
17-
- '#Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder<.*>::whereNested\(\).#'
18-
- '#Dynamic call to static method Kalnoy\\Nestedset\\QueryBuilder<.*>::whereIn\(\).#'
14+
- '#.*covariant.*#'
15+
- '#.*contravariant.*#'
16+
-
17+
message: '#^Call to an undefined method Kalnoy\\Nestedset\\Contracts\\Node<.*>::assert.*\(\)\.$#'

‎src/AncestorsRelation.php

+8-7
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
namespace Kalnoy\Nestedset;
44

55
use Illuminate\Database\Eloquent\Model;
6+
use Kalnoy\Nestedset\Contracts\Node;
7+
use Kalnoy\Nestedset\Contracts\NodeQueryBuilder;
68

79
/**
810
* @template Tmodel of Model
911
*
10-
* @phpstan-type NodeModel Node<Tmodel>&Tmodel
11-
*
12-
* @disregard P1037
12+
* @phpstan-type NodeModel \Kalnoy\Nestedset\Contracts\Node<Tmodel>&Tmodel
1313
*
1414
* @extends BaseRelation<Tmodel>
1515
*/
16-
class AncestorsRelation extends BaseRelation
16+
final class AncestorsRelation extends BaseRelation
1717
{
1818
/**
1919
* Set the base constraints on the relation query.
@@ -36,14 +36,14 @@ public function addConstraints()
3636
*
3737
* @return bool
3838
*/
39-
protected function matches(Model $model, $related): bool
39+
protected function matches(Node $model, Node $related): bool
4040
{
4141
return $related->isAncestorOf($model);
4242
}
4343

4444
/**
45-
* @param QueryBuilder<Tmodel> $query
46-
* @param NodeModel $model
45+
* @param NodeQueryBuilder<Tmodel> $query
46+
* @param NodeModel $model
4747
*
4848
* @return void
4949
*/
@@ -57,6 +57,7 @@ protected function addEagerConstraint($query, $model)
5757
*/
5858
protected function relationExistenceCondition(string $hash, string $table, string $lft, string $rgt): string
5959
{
60+
/** @disregard P1013 */
6061
$key = $this->getBaseQuery()->getGrammar()->wrap($this->parent->getKeyName());
6162

6263
return "{$table}.{$rgt} between {$hash}.{$lft} and {$hash}.{$rgt} and $table.$key <> $hash.$key";

‎src/BaseRelation.php

+19-15
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,24 @@
77
use Illuminate\Database\Eloquent\Model;
88
use Illuminate\Database\Eloquent\Relations\Relation;
99
use Illuminate\Database\Query\Builder;
10+
use Kalnoy\Nestedset\Contracts\NestedSetCollection;
11+
use Kalnoy\Nestedset\Contracts\Node;
12+
use Kalnoy\Nestedset\Contracts\NodeQueryBuilder;
1013

1114
/**
1215
* @template Tmodel of Model
1316
*
14-
* @phpstan-type NodeModel Node<Tmodel>&Tmodel
17+
* @phpstan-type NodeModel Node<Tmodel>&Tmodel
1518
*
16-
* @extends Relation<NodeModel,NodeModel,EloquentCollection<int,NodeModel>>
19+
* @extends Relation<NodeModel,NodeModel,NestedSetCollection<Tmodel>>
1720
*
1821
* @property NodeModel $related
1922
* @property NodeModel $parent
20-
*
21-
* @method NodeModel getParent()
2223
*/
2324
abstract class BaseRelation extends Relation
2425
{
2526
/**
26-
* @var QueryBuilder<Tmodel>
27+
* @var NodeQueryBuilder<Tmodel>
2728
*/
2829
protected $query;
2930

@@ -42,8 +43,8 @@ abstract class BaseRelation extends Relation
4243
/**
4344
* AncestorsRelation constructor.
4445
*
45-
* @param QueryBuilder<Tmodel> $builder
46-
* @param NodeModel $model
46+
* @param QueryBuilder<NodeModel> $builder
47+
* @param NodeModel $model
4748
*/
4849
public function __construct(QueryBuilder $builder, Model $model)
4950
{
@@ -60,11 +61,11 @@ public function __construct(QueryBuilder $builder, Model $model)
6061
*
6162
* @return bool
6263
*/
63-
abstract protected function matches(Model&Node $model, Node $related): bool;
64+
abstract protected function matches(Node $model, Node $related): bool;
6465

6566
/**
66-
* @param QueryBuilder<Tmodel> $query
67-
* @param NodeModel $model
67+
* @param NodeQueryBuilder<Tmodel> $query
68+
* @param NodeModel $model
6869
*
6970
* @return void
7071
*/
@@ -90,6 +91,7 @@ abstract protected function relationExistenceCondition(string $hash, string $tab
9091
public function getRelationExistenceQuery(EloquentBuilder $query, EloquentBuilder $parentQuery,
9192
$columns = ['*'],
9293
) {
94+
/** @disregard P1006 */
9395
$query = $this->getParent()->replicate()->newScopedQuery()->select($columns);
9496

9597
$table = $query->getModel()->getTable();
@@ -106,7 +108,7 @@ public function getRelationExistenceQuery(EloquentBuilder $query, EloquentBuilde
106108
$grammar->wrap($this->parent->getLftName()),
107109
$grammar->wrap($this->parent->getRgtName()));
108110

109-
return $query->whereRaw($condition); /** @phpstan-ignore-line */
111+
return $query->whereRaw($condition);
110112
}
111113

112114
/**
@@ -137,11 +139,11 @@ public function getRelationCountHash($incrementJoinCount = true)
137139
/**
138140
* Get the results of the relationship.
139141
*
140-
* @return Collection<NodeModel>
142+
* @return NestedSetCollection<NodeModel>
141143
*/
142144
public function getResults()
143145
{
144-
/** @var Collection<NodeModel> */
146+
/** @disregard P1013 */
145147
$result = $this->query->get();
146148

147149
return $result;
@@ -164,6 +166,7 @@ public function addEagerConstraints(array $models)
164166
$this->query->whereNested(function (Builder $inner) use ($models) {
165167
// We will use this query in order to apply constraints to the
166168
// base query builder
169+
/** @disregard P1013 */
167170
$outer = $this->parent->newQuery()->setQuery($inner);
168171

169172
foreach ($models as $model) {
@@ -187,6 +190,7 @@ public function match(array $models, EloquentCollection $results, $relation)
187190
/** @disregard P1006 */
188191
$related = $this->matchForModel($model, $results);
189192

193+
/** @disregard P1013 */
190194
$model->setRelation($relation, $related);
191195
}
192196

@@ -197,16 +201,16 @@ public function match(array $models, EloquentCollection $results, $relation)
197201
* @param NodeModel $model
198202
* @param EloquentCollection<int,NodeModel> $results
199203
*
200-
* @return Collection<Tmodel>
204+
* @return NestedSetCollection<Tmodel>
201205
*/
202206
protected function matchForModel(Model $model, EloquentCollection $results)
203207
{
204-
/** @var Collection<Tmodel> */
205208
$result = $this->related->newCollection();
206209

207210
foreach ($results as $related) {
208211
/** @disregard P1006 */
209212
if ($this->matches($model, $related)) {
213+
/** @disregard P1013 */
210214
$result->push($related);
211215
}
212216
}

‎src/Collection.php

+30-21
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@
44

55
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
66
use Illuminate\Database\Eloquent\Model;
7+
use Kalnoy\Nestedset\Contracts\NestedSetCollection;
8+
use Kalnoy\Nestedset\Exceptions\NestedSetException;
79

810
/**
911
* @template Tmodel of Model
1012
*
11-
* @phpstan-type NodeModel Node<Tmodel>&Tmodel
13+
* @phpstan-type NodeModel \Kalnoy\Nestedset\Contracts\Node<Tmodel>&Model
1214
*
1315
* @extends EloquentCollection<array-key,NodeModel>
16+
*
17+
* @implements NestedSetCollection<Tmodel>
1418
*/
15-
final class Collection extends EloquentCollection
19+
final class Collection extends EloquentCollection implements NestedSetCollection
1620
{
1721
/**
1822
* Fill `parent` and `children` relationships for every node in the collection.
@@ -34,16 +38,20 @@ public function linkNodes()
3438
/** @var NodeModel $node */
3539
foreach ($this->items as $node) {
3640
if ($node->getParentId() === null) {
41+
/** @disregard */
3742
$node->setRelation('parent', null);
3843
}
3944

40-
/** @var array<int,NodeModel> */
41-
$children = $groupedNodes->get($node->getKey(), []); /** @phpstan-ignore varTag.type */
45+
$children = $groupedNodes->get($node->getKey(), []);
4246

43-
foreach ($children as $child) {
44-
$child->setRelation('parent', $node);
47+
if (count($children) > 0) {
48+
foreach ($children as $child) {
49+
/** @disregard */
50+
$child->setRelation('parent', $node);
51+
}
4552
}
4653

54+
/** @disregard */
4755
$node->setRelation('children', EloquentCollection::make($children));
4856
}
4957

@@ -59,9 +67,9 @@ public function linkNodes()
5967
*
6068
* @param mixed $root
6169
*
62-
* @return Collection<Tmodel>
70+
* @return NestedSetCollection<Tmodel>
6371
*/
64-
public function toTree($root = false)
72+
public function toTree($root = false): NestedSetCollection
6573
{
6674
if ($this->isEmpty()) {
6775
return new static();
@@ -123,23 +131,22 @@ protected function getRootNodeId($root = false)
123131
*
124132
* @param bool $root
125133
*
126-
* @return Collection<Tmodel>
134+
* @return NestedSetCollection<Tmodel>
127135
*/
128-
public function toFlatTree($root = false): Collection
136+
public function toFlatTree($root = false): NestedSetCollection
129137
{
130138
/** @Var Collection<Tmodel> */
131139
$result = new Collection();
132140

133141
if ($this->isEmpty()) {
134-
return $result; /** @phpstan-ignore-line */
142+
return $result;
135143
}
136144

137145
/** @var NodeModel */
138146
$first = $this->first();
139-
/** @var Collection<NodeModel> */
140-
$groupedNodes = $this->groupBy($first->getParentIdName()); /** @phpstan-ignore varTag.type */
147+
$groupedNodes = $this->groupBy($first->getParentIdName());
141148

142-
return $result->flattenTree($groupedNodes, $this->getRootNodeId($root)); /** @phpstan-ignore-line */
149+
return $result->flattenTree($groupedNodes, $this->getRootNodeId($root));
143150
}
144151

145152
/**
@@ -148,16 +155,18 @@ public function toFlatTree($root = false): Collection
148155
* @param Collection<Tmodel> $groupedNodes
149156
* @param array-key $parentId
150157
*
151-
* @return Collection<Tmodel>
158+
* @return NestedSetCollection<Tmodel>
152159
*/
153-
protected function flattenTree(Collection $groupedNodes, $parentId): Collection
160+
protected function flattenTree(Collection $groupedNodes, $parentId): NestedSetCollection
154161
{
155-
/** @var array<int,NodeModel> */
156-
$nodes = $groupedNodes->get($parentId, []); /** @phpstan-ignore varTag.type */
157-
foreach ($nodes as $node) {
158-
$this->push($node);
162+
$nodes = $groupedNodes->get($parentId, []);
159163

160-
$this->flattenTree($groupedNodes, $node->getKey());
164+
if (count($nodes) > 0) {
165+
foreach ($nodes as $node) {
166+
$this->push($node);
167+
168+
$this->flattenTree($groupedNodes, $node->getKey());
169+
}
161170
}
162171

163172
return $this;

‎src/Contracts/NestedSetCollection.php

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<?php
2+
3+
namespace Kalnoy\Nestedset\Contracts;
4+
5+
/**
6+
* @template-covariant Tmodel of \Illuminate\Database\Eloquent\Model
7+
*
8+
* @phpstan-type NodeModel Node<Tmodel>&Tmodel
9+
*
10+
* @require-extends \Illuminate\Database\Eloquent\Collection
11+
*
12+
* @method NestedSetCollection<NodeModel> groupBy(string $column)
13+
* @method array<int,NodeModel> all()
14+
*/
15+
interface NestedSetCollection
16+
{
17+
/**
18+
* Fill `parent` and `children` relationships for every node in the collection.
19+
*
20+
* This will overwrite any previously set relations.
21+
*
22+
* @return NestedSetCollection<Tmodel>
23+
*/
24+
public function linkNodes();
25+
26+
/**
27+
* Build a tree from a list of nodes. Each item will have set children relation.
28+
*
29+
* To successfully build tree "id", "_lft" and "parent_id" keys must present.
30+
*
31+
* If `$root` is provided, the tree will contain only descendants of that node.
32+
*
33+
* @param mixed $root
34+
*
35+
* @return NestedSetCollection<Tmodel>
36+
*/
37+
public function toTree($root = false): NestedSetCollection;
38+
39+
/**
40+
* Build a list of nodes that retain the order that they were pulled from
41+
* the database.
42+
*
43+
* @param bool $root
44+
*
45+
* @return NestedSetCollection<Tmodel>
46+
*/
47+
public function toFlatTree($root = false): NestedSetCollection;
48+
}

0 commit comments

Comments
 (0)