Skip to content

fix: route versioning #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2025
Merged

fix: route versioning #129

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e77fc6
fix: route versioning
AZabolotnikov Jul 8, 2025
88e0f04
fix: route versioning
AZabolotnikov Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 2 additions & 52 deletions app/Providers/AppServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,67 +3,17 @@
namespace App\Providers;

use App\Enums\VersionEnum;
use Illuminate\Routing\Route;
use Illuminate\Routing\RouteRegistrar;
use Illuminate\Support\Facades\Route as RouteFacade;
use Illuminate\Support\ServiceProvider;
use RonasIT\Support\Contracts\VersionEnumContract;

class AppServiceProvider extends ServiceProvider
{
public function boot(): void
{
/**
* Specify that the route version must be in the range of given values inclusive.
*
* @param VersionEnum|null $start
* @param VersionEnum|null $end
* @param string|null $param (default is 'version')
* @param Route|null $instance
*
* @return Route|RouteRegistrar
*/
$versionRange = function (?VersionEnum $start, ?VersionEnum $end, ?string $param, ?Route $instance = null) {
if (!$param) {
$param = 'version';
}

$versions = array_diff(VersionEnum::values(), config('app.disabled_api_versions'));

$versions = array_filter($versions, function ($version) use ($start, $end) {
$result = true;

if (!empty($start)) {
$result &= version_compare($version, $start->value, '>=');
}

if (!empty($end)) {
$result &= version_compare($version, $end->value, '<=');
}

return $result;
});

return (!empty($instance))
? $instance->whereIn($param, $versions)
: RouteFacade::whereIn($param, $versions);
};

Route::macro('versionRange', fn (VersionEnum $from, VersionEnum $to, $param = null) => $versionRange($from, $to, $param, $this));

Route::macro('versionFrom', fn (VersionEnum $from, $param = null) => $versionRange($from, null, $param, $this));

Route::macro('versionTo', fn (VersionEnum $to, $param = null) => $versionRange(null, $to, $param, $this));

RouteFacade::macro('versionRange', fn (VersionEnum $from, VersionEnum $to, $param = null) => $versionRange($from, $to, $param));

RouteFacade::macro('versionFrom', fn (VersionEnum $from, $param = null) => $versionRange($from, null, $param));

RouteFacade::macro('versionTo', fn (VersionEnum $to, $param = null) => $versionRange(null, $to, $param));

RouteFacade::macro('version', fn (VersionEnum $version) => RouteFacade::prefix('v' . $version->value));
}

public function register()
{
$this->app->bind(VersionEnumContract::class, fn () => VersionEnum::class);
}
}