Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soyhuce/laravel-fluent-policy
Write fluent policies in Laravel
https://github.com/soyhuce/laravel-fluent-policy
hacktoberfest
Last synced: 2 months ago
JSON representation
Write fluent policies in Laravel
- Host: GitHub
- URL: https://github.com/soyhuce/laravel-fluent-policy
- Owner: Soyhuce
- License: mit
- Created: 2022-04-29T09:59:29.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T23:29:11.000Z (9 months ago)
- Last Synced: 2024-11-24T20:50:09.842Z (2 months ago)
- Topics: hacktoberfest
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Write fluent policies in Laravel
[](https://packagist.org/packages/soyhuce/laravel-fluent-policy)
[](https://github.com/soyhuce/laravel-fluent-policy/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/soyhuce/laravel-fluent-policy/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://github.com/soyhuce/laravel-fluent-policy/actions?query=workflow%3APHPStan+branch%3Amain)
[](https://packagist.org/packages/soyhuce/laravel-fluent-policy)
Write your policies fluently in Laravel.
```php
denyWhen($post->user_id !== $user->id)
->denyWhen($post->published_at !== null)
->allow();
}
}
```
## Installation
You can install the package via composer:
```bash
composer require soyhuce/laravel-fluent-policy
```
## Usage
The goal of this package is to write your policies more easily in a clean syntax.
For exemple, the following policy:
```php
user_id !== $user->id) {
return false;
}
if ($post->published_at !== null) {
return false;
}
return true;
}
}
```
can be re-written as:
```php
denyWhen($post->user_id !== $user->id)
->denyWhen($post->published_at !== null)
->allow();
}
}
```
You can customise the response if needed :
```php
return $this->denyWhen($post->published_at !== null, 'You cannot delete a published post')
->allow();
```
You can also call another policy or gate this way :
```php
return $this->authorize($user, 'update', $post)
->allowWhen($post->published_at === null)
->deny();
```
### Custom Http status
You can deny the policy returning a custom http status code :
```php
return $this->denyWithStatusWhen($post->user_id !== $user->id, 404)
->allow();
// or $this->>allowWhen(...)->denyWithStatus(404);
```
In the case of `404` status code, you can use the shortcut
```php
return $this->denyAsNotFoundWhen($post->user_id !== $user->id)
->allow();
// or $this->>allowWhen(...)->denyAsNotFound();
```
### Lazy evaluation
The different branches `allowWhen` and `denyWhen` are evaluated lazily which mean that the following code is completely
correct :
```php
published_at is Carbon or null
return $this->denyWhen($post->user_id !== $user->id)
->allowWhen($post->published_at === null) // 1
->allowWhen($post->published_at->isFuture()) // 2
->deny();
}
}
```
`2` will only be called if previous branches are all false. We are sure that here `$post->published_at` is not null
thanks to `1`.
## PHPStan
When running PHPStan on
```php
public function delete(User $user, Post $post): Response
{
return $this->denyWhen($post->user_id !== $user->id)
->allowWhen($post->published_at === null) // 1
->allowWhen($post->published_at->isFuture()) // 2
->deny();
}
```
an error is raised on `2` (`Cannot call method `isFuture` on Carbon|null`).
An extension is available to fix this issue and should be included in your `phpstan.neon` file.
```neon
includes:
- vendor/bin/soyhuce/laravel-fluent-policies/extension.neon
```
Unfortunately, due to a PHPStan limitation, you still have to rewrite your policy a little bit :
```php
public function delete(User $user, Post $post): Response
{
$this->denyWhen($post->user_id !== $user->id)
->allowWhen($post->published_at === null);
// From here, PHPStan understands that $post->published_at is not null
return $this->allowWhen($post->published_at->isFuture())
->deny();
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Bastien Philippe](https://github.com/bastien-phi)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.