Skip to content

Added FrequencyEnum for Reset Frequency Values #1

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,19 @@ $projectsStandardLimit->incrementBy(10);
$projectsProLimit->decrementBy(3);
```

###### Possible values for "reset_frequency" column
###### Possible values for "reset_frequency" column came from src/Enum/FrequencyEnum.php

- null
- "every second" // works in Laravel >= 10
- "every minute"
- "every hour"
- "every day"
- "every week",
- "every two weeks",
- "every month",
- "every quarter",
- "every six months",
- "every year"
- EVERY_SECOND = 'every second' // works in laravel >= 10.x
- EVERY_MINUTE = 'every minute'
- EVERY_HOUR = 'every hour'
- EVERY_DAY = 'every day'
- EVERY_WEEK = 'every week'
- EVERY_TWO_WEEKS = 'every two weeks'
- EVERY_MONTH = 'every month'
- EVERY_QUARTER = 'every quarter'
- EVERY_SIX_MONTHS = 'every six months'
- EVERY_YEAR = 'every year'

#### Set Limits on models

Expand Down
42 changes: 42 additions & 0 deletions src/Enum/FrequencyEnum.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?php

namespace NabilHassen\LaravelUsageLimiter\Enum;

use Carbon\Carbon;

enum FrequencyEnum: string
{
case EVERY_SECOND = 'every second';
case EVERY_MINUTE = 'every minute';
case EVERY_HOUR = 'every hour';
case EVERY_DAY = 'every day';
case EVERY_WEEK = 'every week';
case EVERY_TWO_WEEKS = 'every two weeks';
case EVERY_MONTH = 'every month';
case EVERY_QUARTER = 'every quarter';
case EVERY_SIX_MONTHS = 'every six months';
case EVERY_YEAR = 'every year';

public static function toArray(): array
{
return array_column(self::cases(), 'value');
}

public function getCarbonEquivalent(string|Carbon $lastReset): Carbon
{
$lastReset = Carbon::parse($lastReset);

return match ($this) {
self::EVERY_SECOND => $lastReset->addSecond(),
self::EVERY_MINUTE => $lastReset->addMinute(),
self::EVERY_HOUR => $lastReset->addHour(),
self::EVERY_DAY => $lastReset->addDay(),
self::EVERY_WEEK => $lastReset->addWeek(),
self::EVERY_TWO_WEEKS => $lastReset->addWeeks(2),
self::EVERY_MONTH => $lastReset->addMonth(),
self::EVERY_QUARTER => $lastReset->addQuarter(),
self::EVERY_SIX_MONTHS => $lastReset->addMonths(6),
self::EVERY_YEAR => $lastReset->addYear(),
};
}
}
27 changes: 11 additions & 16 deletions src/LimitManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use Illuminate\Support\Facades\Cache;
use InvalidArgumentException;
use NabilHassen\LaravelUsageLimiter\Contracts\Limit;
use NabilHassen\LaravelUsageLimiter\Enum\FrequencyEnum;
use NabilHassen\LaravelUsageLimiter\Exceptions\InvalidLimitResetFrequencyValue;

class LimitManager
Expand Down Expand Up @@ -52,26 +53,20 @@ public function initCache(): void
$this->cache = Cache::store($cacheStore);
}

public function getNextReset(string $limitResetFrequency, string|Carbon $lastReset): Carbon
public function getNextReset(string|FrequencyEnum $limitResetFrequency, string|Carbon $lastReset): Carbon
{
if ($this->limitClass->getResetFrequencyOptions()->doesntContain($limitResetFrequency)) {
if(!$limitResetFrequency instanceof FrequencyEnum) {
if(!$limitResetFrequency = FrequencyEnum::tryFrom($limitResetFrequency)){
throw new InvalidLimitResetFrequencyValue;
}
}

if ($this->limitClass->getResetFrequencyOptions()->doesntContain($limitResetFrequency->value)) {
throw new InvalidLimitResetFrequencyValue;
}

$lastReset = Carbon::parse($lastReset);

return match ($limitResetFrequency) {
'every second' => $lastReset->addSecond(),
'every minute' => $lastReset->addMinute(),
'every hour' => $lastReset->addHour(),
'every day' => $lastReset->addDay(),
'every week' => $lastReset->addWeek(),
'every two weeks' => $lastReset->addWeeks(2),
'every month' => $lastReset->addMonth(),
'every quarter' => $lastReset->addQuarter(),
'every six months' => $lastReset->addMonths(6),
'every year' => $lastReset->addYear(),
};
return $limitResetFrequency->getCarbonEquivalent($lastReset);

}

public function loadLimits(): void
Expand Down
18 changes: 5 additions & 13 deletions src/Models/Limit.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use Illuminate\Support\Collection;
use InvalidArgumentException;
use NabilHassen\LaravelUsageLimiter\Contracts\Limit as LimitContract;
use NabilHassen\LaravelUsageLimiter\Enum\FrequencyEnum;
use NabilHassen\LaravelUsageLimiter\Exceptions\InvalidLimitResetFrequencyValue;
use NabilHassen\LaravelUsageLimiter\Exceptions\LimitAlreadyExists;
use NabilHassen\LaravelUsageLimiter\Exceptions\LimitDoesNotExist;
Expand All @@ -20,17 +21,8 @@ class Limit extends Model implements LimitContract

protected $guarded = ['id', 'created_at', 'updated_at', 'deleted_at'];

protected static array $resetFrequencyPossibleValues = [
'every second',
'every minute',
'every hour',
'every day',
'every week',
'every two weeks',
'every month',
'every quarter',
'every six months',
'every year',
protected $casts = [
'reset_frequency' => FrequencyEnum::class,
];

public function __construct(array $attributes = [])
Expand Down Expand Up @@ -75,7 +67,7 @@ protected static function validateArgs(array $data): array
if (
Arr::has($data, ['reset_frequency']) &&
filled($data['reset_frequency']) &&
array_search($data['reset_frequency'], static::$resetFrequencyPossibleValues) === false
!in_array($data['reset_frequency'], FrequencyEnum::toArray())
) {
throw new InvalidLimitResetFrequencyValue;
}
Expand Down Expand Up @@ -141,6 +133,6 @@ public function decrementBy(float|int $amount = 1.0): bool

public function getResetFrequencyOptions(): Collection
{
return collect(static::$resetFrequencyPossibleValues);
return collect(FrequencyEnum::toArray());
}
}
5 changes: 4 additions & 1 deletion tests/Feature/LimitManagerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use Illuminate\Support\Str;
use InvalidArgumentException;
use NabilHassen\LaravelUsageLimiter\Contracts\Limit;
use NabilHassen\LaravelUsageLimiter\Enum\FrequencyEnum;
use NabilHassen\LaravelUsageLimiter\Exceptions\InvalidLimitResetFrequencyValue;
use NabilHassen\LaravelUsageLimiter\LimitManager;
use NabilHassen\LaravelUsageLimiter\Tests\TestCase;
Expand Down Expand Up @@ -112,7 +113,9 @@ public function test_exception_is_thrown_if_invalid_reset_frequency_is_passed_to

public function test_get_next_reset_returns_carbon_date(): void
{
$date = $this->limitManagerClass->getNextReset(app(Limit::class)->getResetFrequencyOptions()->random(), now());
$limit_frequency = FrequencyEnum::from(app(Limit::class)->getResetFrequencyOptions()->random());

$date = $this->limitManagerClass->getNextReset($limit_frequency, now());

$this->assertInstanceOf(Carbon::class, $date);
}
Expand Down
Loading