Skip to content

Commit 00702aa

Browse files
emreakayemreakay
authored
Merge pull request #57 from AuroraWebSoftware/refactor-query-builder-for-updated-abac-rules
Refactor AAuthABACModelScope for updated ABAC rule format and add tests
2 parents 04d0a78 + b1d1619 commit 00702aa

File tree

3 files changed

+166
-119
lines changed

3 files changed

+166
-119
lines changed

‎src/Facades/AAuth.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* @static switchableRolesStatic(int $userId): array|Collection|\Illuminate\Support\Collection
2323
*
2424
* @method static currentRole() \AuroraWebSoftware\AAuth\Models\Role|null
25-
* @method static ABACRules() array|null
25+
* @method static ABACRules(string $modelType) array|null
2626
*/
2727
class AAuth extends Facade
2828
{

‎src/Scopes/AAuthABACModelScope.php

+77-90
Original file line numberDiff line numberDiff line change
@@ -3,118 +3,105 @@
33
namespace AuroraWebSoftware\AAuth\Scopes;
44

55
use AuroraWebSoftware\AAuth\Facades\AAuth;
6+
use AuroraWebSoftware\AAuth\Interfaces\AAuthABACModelInterface;
67
use AuroraWebSoftware\AAuth\Utils\ABACUtil;
78
use Exception;
89
use Illuminate\Database\Eloquent\Builder;
910
use Illuminate\Database\Eloquent\Model;
1011
use Illuminate\Database\Eloquent\Scope;
1112

13+
/**
14+
* @template TModelClass of Model
15+
*/
1216
class AAuthABACModelScope implements Scope
1317
{
1418
/**
19+
* @param Builder<TModelClass> $builder
20+
* @param Model $model
21+
* @param mixed $rules
22+
* @param string $parentOperator
23+
* @return void
1524
* @throws Exception
1625
*/
17-
public function apply(Builder $builder, Model $model, $rules = false, $parentOperator = '&&')
26+
public function apply(Builder $builder, Model $model, mixed $rules = false, string $parentOperator = '&&'): void
1827
{
1928
if ($rules === false) {
29+
/**
30+
* @var AAuthABACModelInterface $model
31+
*
32+
* PHPStan analysis does not return any errors, but it underlines the ABACRules method because it somehow
33+
* does not see it, even though it is defined in the facade.
34+
* @phpstan-ignore-next-line
35+
*/
2036
$rules = AAuth::ABACRules($model::getModelType()) ?? [];
37+
38+
/**
39+
* @var array $rules
40+
*/
2141
ABACUtil::validateAbacRuleArray($rules);
2242

23-
return $builder->where(
24-
function ($query) use ($rules, $model) {
25-
$this->apply($query, $model, $rules);
26-
}
27-
);
28-
}
43+
$builder->where(function ($query) use ($rules, $model) {
44+
/**
45+
* @var Model $model
46+
*/
47+
$this->apply($query, $model, $rules);
48+
});
49+
} else {
50+
$logicalOperators = ["&&","||"];
2951

30-
// todo refactor gerekebilir
31-
foreach ($rules as $key => $rule) {
32-
if ($key == '&&') {
33-
if ($parentOperator == '||') {
34-
$builder->orWhere(
35-
function ($query) use ($rule, $model) {
36-
$this->apply($query, $model, $rule);
37-
}
38-
);
39-
} else {
40-
$builder->where(
41-
function ($query) use ($rule, $model) {
42-
$this->apply($query, $model, $rule);
43-
}
44-
);
45-
}
46-
} elseif ($key == '||') {
47-
if ($parentOperator == '||') {
48-
$builder->orWhere(
49-
function ($query) use ($rule, $model) {
50-
$this->apply($query, $model, $rule, '||');
51-
}
52-
);
53-
} else {
54-
$builder->where(
55-
function ($query) use ($rule, $model) {
56-
$this->apply($query, $model, $rule, '||');
57-
}
58-
);
59-
}
60-
} else {
61-
$operator = array_key_first($rule);
62-
if ($parentOperator == '||') {
63-
$builder->orWhere(
64-
$rule[array_key_first($rule)]['attribute'],
65-
$operator,
66-
$rule[array_key_first($rule)]['value']
67-
);
52+
foreach ($rules as $rule) {
53+
$firstKey = array_key_first($rule);
54+
$abacRule = $rule[$firstKey];
55+
56+
if (in_array($firstKey, $logicalOperators)) {
57+
$this->applyLogicalOperator($builder, $abacRule, $model, $firstKey, $parentOperator);
6858
} else {
69-
$builder->where(
70-
$rule[array_key_first($rule)]['attribute'],
71-
$operator,
72-
$rule[array_key_first($rule)]['value']
73-
);
59+
$this->applyConditionalOperator($builder, $rule, $parentOperator);
7460
}
7561
}
7662
}
63+
}
64+
65+
/**
66+
* Apply logical operator (&& or ||) to the query builder.
67+
*
68+
* @param Builder<TModelClass> $builder
69+
* @param array $abacRule
70+
* @param Model $model
71+
* @param string $logicalOperator
72+
* @param string $parentOperator
73+
*
74+
* @return void
75+
* @throws Exception
76+
*/
77+
protected function applyLogicalOperator(Builder $builder, array $abacRule, Model $model, string $logicalOperator, string $parentOperator): void
78+
{
79+
$queryMethod = $parentOperator == '&&' ? 'where' : 'orWhere';
7780

78-
// todo refactor gerekebilir
79-
/*
80-
foreach ($rules as $key => $rule) {
81-
if ($key == '&&') {
82-
foreach ($rule as $subkey => $subrule) {
83-
$suboperator = array_key_first($subrule);
81+
$builder->{$queryMethod}(function ($query) use ($abacRule, $model, $logicalOperator) {
82+
$this->apply($query, $model, $abacRule, $logicalOperator);
83+
});
84+
}
8485

85-
if ($suboperator == '&&' or $suboperator == '||') {
86-
$builder->where(
87-
function ($query) use ($subrule, $model) {
88-
$this->apply($query, $model, $subrule);
89-
}
90-
);
91-
} else {
92-
$builder->where(
93-
$subrule[array_key_first($subrule)]['attribute'],
94-
$suboperator,
95-
$subrule[array_key_first($subrule)]['value']
96-
);
97-
}
98-
}
99-
} elseif ($key == '||') {
100-
foreach ($rule as $subkey => $subrule) {
101-
$suboperator = array_key_first($subrule);
102-
if ($suboperator == '&&' || $suboperator == '||') {
103-
$builder->where(
104-
function ($query) use ($subrule, $model) {
105-
$this->apply($query, $model, $subrule);
106-
}
107-
);
108-
} else {
109-
$builder->orWhere(
110-
$subrule[array_key_first($subrule)]['attribute'],
111-
$suboperator,
112-
$subrule[array_key_first($subrule)]['value']
113-
);
114-
}
115-
}
116-
}
117-
}
118-
*/
86+
/**
87+
* Apply conditional operator to the query builder.
88+
*
89+
* @param Builder<TModelClass> $builder
90+
* @param array $rule
91+
* @param string $parentOperator
92+
*
93+
* @return void
94+
*/
95+
protected function applyConditionalOperator(Builder $builder, array $rule, string $parentOperator): void
96+
{
97+
$operator = array_key_first($rule);
98+
99+
$queryMethod = $parentOperator == '||' ? 'orWhere' : 'where';
100+
101+
$builder->{$queryMethod}(
102+
$rule[$operator]['attribute'],
103+
$operator,
104+
$rule[$operator]['value']
105+
);
119106
}
120107
}

0 commit comments

Comments
 (0)