Skip to content

Commit ea12db5

Browse files
committed
Apply fixes from StyleCI
1 parent 755a5aa commit ea12db5

26 files changed

+121
-119
lines changed

config/access-control.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
*/
1212

1313
'perimeters' => [
14-
'path' => app_path('Access/Perimeters')
14+
'path' => app_path('Access/Perimeters'),
1515
],
1616

1717
/*
@@ -22,6 +22,6 @@
2222
|
2323
*/
2424
'queries' => [
25-
'enabled_by_default' => true
26-
]
25+
'enabled_by_default' => true,
26+
],
2727
];

src/AccessServiceProvider.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
namespace Lomkit\Access;
44

5-
use Illuminate\Database\Eloquent\Builder;
65
use Illuminate\Support\ServiceProvider;
76
use Lomkit\Access\Perimeters\Perimeters;
87

src/ControlScope.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
use Illuminate\Database\Eloquent\Builder;
66
use Illuminate\Database\Eloquent\Model;
77
use Illuminate\Database\Eloquent\Scope;
8-
use Illuminate\Http\Client\Request;
98
use Lomkit\Access\Controls\Control;
109

1110
class ControlScope implements Scope
@@ -30,7 +29,8 @@ public function apply(Builder $builder, Model $model): void
3029
/**
3130
* Extend the query builder with the needed functions.
3231
*
33-
* @param \Illuminate\Database\Eloquent\Builder $builder
32+
* @param \Illuminate\Database\Eloquent\Builder $builder
33+
*
3434
* @return void
3535
*/
3636
public function extend(Builder $builder)
@@ -43,7 +43,8 @@ public function extend(Builder $builder)
4343
/**
4444
* Add the with-control extension to the builder.
4545
*
46-
* @param \Illuminate\Database\Eloquent\Builder $builder
46+
* @param \Illuminate\Database\Eloquent\Builder $builder
47+
*
4748
* @return void
4849
*/
4950
protected function addWithControl(Builder $builder)
@@ -59,7 +60,8 @@ protected function addWithControl(Builder $builder)
5960
/**
6061
* Add the without-control extension to the builder.
6162
*
62-
* @param \Illuminate\Database\Eloquent\Builder $builder
63+
* @param \Illuminate\Database\Eloquent\Builder $builder
64+
*
6365
* @return void
6466
*/
6567
protected function addWithoutControl(Builder $builder)
@@ -68,4 +70,4 @@ protected function addWithoutControl(Builder $builder)
6870
return $builder->withoutGlobalScope($this);
6971
});
7072
}
71-
}
73+
}

src/Controls/Concerns/HasPolicy.php

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,24 @@
22

33
namespace Lomkit\Access\Controls\Concerns;
44

5-
use http\Exception\RuntimeException;
6-
use Illuminate\Database\Eloquent\Builder;
75
use Illuminate\Database\Eloquent\Model;
8-
use Illuminate\Http\Request;
96
use Illuminate\Support\Str;
10-
use Lomkit\Access\Exceptions\QueryNotImplemented;
117
use Lomkit\Access\Perimeters\Perimeter;
128
use Lomkit\Access\Queries\Query;
139

1410
trait HasPolicy
1511
{
16-
public function runPolicy(string $method, Model $user, Model $model) {
12+
public function runPolicy(string $method, Model $user, Model $model)
13+
{
1714
$concernedPerimeters = $this->getConcernedPerimeters();
1815

1916
return $concernedPerimeters->contains(function (Perimeter $concernedPerimeter) use ($method, $model, $user) {
2017
return $this->policy($concernedPerimeter, $method, $user, $model);
2118
});
2219
}
2320

24-
public function policy(Perimeter $perimeter, string $method, Model $user, Model $model) : bool {
21+
public function policy(Perimeter $perimeter, string $method, Model $user, Model $model): bool
22+
{
2523
// @TODO: for the "shared" example, implement the fact that for the query you can add multiple query
2624
$policyMethod = Str::camel($perimeter->name).'Policy';
2725

@@ -31,4 +29,4 @@ public function policy(Perimeter $perimeter, string $method, Model $user, Model
3129

3230
return false;
3331
}
34-
}
32+
}

src/Controls/Concerns/HasQuery.php

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,46 @@
22

33
namespace Lomkit\Access\Controls\Concerns;
44

5-
use http\Exception\RuntimeException;
65
use Illuminate\Database\Eloquent\Builder;
7-
use Illuminate\Http\Request;
86
use Illuminate\Support\Str;
97
use Lomkit\Access\Exceptions\QueryNotImplemented;
108
use Lomkit\Access\Perimeters\Perimeter;
11-
use Lomkit\Access\Queries\Query;
129

1310
trait HasQuery
1411
{
15-
public function runQuery(Builder $query) {
12+
public function runQuery(Builder $query)
13+
{
1614
if (($concernedPerimeters = $this->getConcernedPerimeters())->isNotEmpty()) {
1715
return tap($query, function (Builder $query) use ($concernedPerimeters) {
18-
foreach ($concernedPerimeters as $concernedPerimeter) {
19-
$this->query($concernedPerimeter, $query);
20-
if ($concernedPerimeter->final()) {
21-
return;
22-
}
23-
}
16+
foreach ($concernedPerimeters as $concernedPerimeter) {
17+
$this->query($concernedPerimeter, $query);
18+
if ($concernedPerimeter->final()) {
19+
return;
20+
}
21+
}
2422
});
25-
return ;
23+
24+
return;
2625
}
2726

2827
return $this->fallbackQuery($query);
2928
}
3029

31-
public function query(Perimeter $perimeter, Builder $query) : Builder {
30+
public function query(Perimeter $perimeter, Builder $query): Builder
31+
{
3232
$queryMethod = Str::camel($perimeter->name).'Query';
3333

3434
if (method_exists($this, $queryMethod)) {
3535
$this->$queryMethod($query);
36+
3637
return $query;
3738
}
3839

3940
throw new QueryNotImplemented(sprintf('The %s method is not implemented in the %s class', $queryMethod, get_class($this)));
4041
}
4142

42-
public function fallbackQuery(Builder $query) : Builder {
43+
public function fallbackQuery(Builder $query): Builder
44+
{
4345
return $query;
4446
}
45-
}
47+
}

src/Controls/Control.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
namespace Lomkit\Access\Controls;
44

5-
use Illuminate\Http\Request;
65
use Illuminate\Support\Collection;
76
use Illuminate\Support\Str;
87
use Lomkit\Access\Controls\Concerns\HasPolicy;
@@ -12,7 +11,8 @@
1211

1312
class Control
1413
{
15-
use HasQuery, HasPolicy;
14+
use HasQuery;
15+
use HasPolicy;
1616

1717
protected Perimeters $perimeters;
1818

@@ -23,7 +23,8 @@ public function __construct(Perimeters $perimeters)
2323
$this->perimeters = $perimeters;
2424
}
2525

26-
public function should(Perimeter $perimeter): bool {
26+
public function should(Perimeter $perimeter): bool
27+
{
2728
$perimeterMethod = 'should'.Str::studly($perimeter->name);
2829

2930
if (method_exists($this, $perimeterMethod)) {
@@ -33,7 +34,8 @@ public function should(Perimeter $perimeter): bool {
3334
return false;
3435
}
3536

36-
public function getConcernedPerimeters(): Collection {
37+
public function getConcernedPerimeters(): Collection
38+
{
3739
if (isset($this->concernedPerimeters)) {
3840
return $this->concernedPerimeters;
3941
}
@@ -48,4 +50,4 @@ public function getConcernedPerimeters(): Collection {
4850

4951
return $this->concernedPerimeters = $perimeters;
5052
}
51-
}
53+
}

src/Exceptions/QueryNotImplemented.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44

55
class QueryNotImplemented extends \RuntimeException
66
{
7-
8-
}
7+
}

src/Perimeters/Perimeter.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
namespace Lomkit\Access\Perimeters;
44

5-
use Illuminate\Http\Request;
6-
use Illuminate\Routing\Matching\MethodValidator;
75
use Illuminate\Support\Str;
86

97
class Perimeter
@@ -63,10 +61,11 @@ public function final(): int
6361
* Determine if the perimeter matches a given name.
6462
*
6563
* @param string $name
64+
*
6665
* @return bool
6766
*/
6867
public function matches(string $name)
6968
{
7069
return $name === $this->name();
7170
}
72-
}
71+
}

src/Perimeters/PerimeterCollection.php

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ class PerimeterCollection
2323
/**
2424
* Add a Perimeter instance to the collection.
2525
*
26-
* @param Perimeter $perimeter
26+
* @param Perimeter $perimeter
27+
*
2728
* @return Perimeter
2829
*/
2930
public function add(Perimeter $perimeter): PerimeterCollection
@@ -36,7 +37,8 @@ public function add(Perimeter $perimeter): PerimeterCollection
3637
/**
3738
* Add the given perimeter to the arrays of perimeters.
3839
*
39-
* @param Perimeter $perimeter
40+
* @param Perimeter $perimeter
41+
*
4042
* @return void
4143
*/
4244
protected function addToCollections(Perimeter $perimeter)
@@ -52,10 +54,11 @@ protected function addToCollections(Perimeter $perimeter)
5254
/**
5355
* Find the first perimeter matching a given name.
5456
*
55-
* @param string $name
56-
* @return Perimeter
57+
* @param string $name
5758
*
5859
* @throws \RuntimeException
60+
*
61+
* @return Perimeter
5962
*/
6063
public function match(string $name)
6164
{
@@ -69,8 +72,9 @@ public function match(string $name)
6972
/**
7073
* Determine if a perimeter in the array matches the name.
7174
*
72-
* @param Perimeter[] $perimeters
73-
* @param \Illuminate\Http\Request $request
75+
* @param Perimeter[] $perimeters
76+
* @param \Illuminate\Http\Request $request
77+
*
7478
* @return Perimeter|null
7579
*/
7680
protected function matchAgainstPerimeters(array $perimeters, string $name)
@@ -83,15 +87,16 @@ protected function matchAgainstPerimeters(array $perimeters, string $name)
8387
/**
8488
* Handle the matched perimeter.
8589
*
86-
* @param string $name
87-
* @param Perimeter|null $perimeter
88-
* @return Perimeter
90+
* @param string $name
91+
* @param Perimeter|null $perimeter
8992
*
9093
* @throws \RuntimeException
94+
*
95+
* @return Perimeter
9196
*/
9297
protected function handleMatchedPerimeter(string $name, $perimeter)
9398
{
94-
if (! is_null($perimeter)) {
99+
if (!is_null($perimeter)) {
95100
return $perimeter;
96101
}
97102

@@ -105,6 +110,7 @@ protected function handleMatchedPerimeter(string $name, $perimeter)
105110
* Get perimeters from the collection by priority.
106111
*
107112
* @param int|null $priority
113+
*
108114
* @return Perimeter[]
109115
*/
110116
public function get(int $priority = null)
@@ -121,4 +127,4 @@ public function getPerimeters()
121127
{
122128
return array_values($this->allPerimeters);
123129
}
124-
}
130+
}

src/Perimeters/Perimeters.php

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@ class Perimeters
2323
*/
2424
public function __construct()
2525
{
26-
$this->perimeters = new PerimeterCollection;
26+
$this->perimeters = new PerimeterCollection();
2727
}
2828

2929
/**
3030
* Add a route to the underlying route collection.
3131
*
3232
* @param Perimeter $perimeter
33+
*
3334
* @return PerimeterCollection
3435
*/
3536
public function addPerimeter(Perimeter $perimeter): PerimeterCollection
@@ -40,7 +41,8 @@ public function addPerimeter(Perimeter $perimeter): PerimeterCollection
4041
/**
4142
* Find the perimeter matching a given name.
4243
*
43-
* @param \Illuminate\Http\Request $request
44+
* @param \Illuminate\Http\Request $request
45+
*
4446
* @return Perimeter
4547
*/
4648
public function findPerimeter(string $name)
@@ -63,7 +65,8 @@ public function getPerimeters()
6365
/**
6466
* Register all the perimeter classes in the given directory.
6567
*
66-
* @param string $directory
68+
* @param string $directory
69+
*
6770
* @return void
6871
*/
6972
public function perimetersIn($directory)
@@ -72,17 +75,17 @@ public function perimetersIn($directory)
7275

7376
foreach ((new Finder())->in($directory)->files() as $perimeter) {
7477
$perimeter = $namespace.str_replace(
75-
['/', '.php'],
76-
['\\', ''],
77-
Str::after($perimeter->getPathname(), app_path().DIRECTORY_SEPARATOR)
78-
);
78+
['/', '.php'],
79+
['\\', ''],
80+
Str::after($perimeter->getPathname(), app_path().DIRECTORY_SEPARATOR)
81+
);
7982

8083
if (
8184
is_subclass_of($perimeter, \Lomkit\Access\Perimeters\Perimeter::class) &&
82-
! (new ReflectionClass($perimeter))->isAbstract()
85+
!(new ReflectionClass($perimeter))->isAbstract()
8386
) {
8487
$this->addPerimeter($perimeter);
8588
}
8689
}
8790
}
88-
}
91+
}

0 commit comments

Comments
 (0)