Skip to content

Commit d903071

Browse files
lukas-freylukas-frey
committed
Merge remote-tracking branch 'origin/main'
2 parents 3189ae8 + 2930e8e commit d903071

15 files changed

+84
-114
lines changed

‎database/factories/SequencePeriodFactory.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence\Database\Factories;
56

6-
use Illuminate\Database\Eloquent\Factories\Factory;
77
use Guava\Sequence\Models\SequencePeriod;
8+
use Illuminate\Database\Eloquent\Factories\Factory;
89

910
class SequencePeriodFactory extends Factory
1011
{
@@ -23,7 +24,7 @@ class SequencePeriodFactory extends Factory
2324
public function definition()
2425
{
2526
return [
26-
'date' => $this->faker->dateTimeBetween('-1 year')->format('Y-m-d'),
27+
'date' => $this->faker->dateTimeBetween('-1 year')->format('Y-m-d'),
2728
'ordinal_number' => $this->faker->numberBetween(1, 100),
2829
];
2930
}

‎database/factories/SequenceRuleFactory.php

+6-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence\Database\Factories;
56

6-
use Illuminate\Database\Eloquent\Factories\Factory;
7-
use InvalidArgumentException;
87
use Guava\Sequence\Enums\ResetFrequency;
98
use Guava\Sequence\Models\SequenceRule;
9+
use Illuminate\Database\Eloquent\Factories\Factory;
10+
use InvalidArgumentException;
1011

1112
class SequenceRuleFactory extends Factory
1213
{
@@ -25,9 +26,9 @@ class SequenceRuleFactory extends Factory
2526
public function definition()
2627
{
2728
return [
28-
'type' => $this->faker->unique()->word(),
29+
'type' => $this->faker->unique()->word(),
2930
'reset_frequency' => $this->faker->randomElement(ResetFrequency::getValues()),
30-
'pattern' => function (array $attributes) {
31+
'pattern' => function (array $attributes) {
3132
return $this->faker->randomElement(
3233
$this->examplePatterns($attributes['reset_frequency'])
3334
);
@@ -38,8 +39,7 @@ public function definition()
3839
/**
3940
* Get example patterns for given reset frequency
4041
*
41-
* @param string $resetFrequency
42-
* @return array<string>
42+
* @return array<string>
4343
*/
4444
private function examplePatterns(string $resetFrequency): array
4545
{
@@ -59,8 +59,6 @@ private function examplePatterns(string $resetFrequency): array
5959

6060
/**
6161
* Indicate that sequence should resets daily.
62-
*
63-
* @return \Illuminate\Database\Eloquent\Factories\Factory
6462
*/
6563
public function resetsDaily(): Factory
6664
{
@@ -73,8 +71,6 @@ public function resetsDaily(): Factory
7371

7472
/**
7573
* Indicate that sequence should resets monthly.
76-
*
77-
* @return \Illuminate\Database\Eloquent\Factories\Factory
7874
*/
7975
public function resetsMonthly(): Factory
8076
{
@@ -87,8 +83,6 @@ public function resetsMonthly(): Factory
8783

8884
/**
8985
* Indicate that sequence should resets yearly.
90-
*
91-
* @return \Illuminate\Database\Eloquent\Factories\Factory
9286
*/
9387
public function resetsYearly(): Factory
9488
{

‎database/migrations/2021_06_01_100000_create_sequence_rules_table.php

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
use Illuminate\Database\Migrations\Migration;

‎database/migrations/2021_06_01_200000_create_sequence_periods_table.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
use Illuminate\Database\Migrations\Migration;
@@ -17,7 +18,8 @@ public function up()
1718
Schema::create('sequence_periods', function (Blueprint $table) {
1819
$table->id();
1920
$table->foreignId('rule_id')->constrained('sequence_rules')
20-
->cascadeOnUpdate()->restrictOnDelete();
21+
->cascadeOnUpdate()->restrictOnDelete()
22+
;
2123
$table->date('date');
2224
$table->unsignedInteger('ordinal_number');
2325
$table->timestamps();

‎src/Enums/ResetFrequency.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence\Enums;
56

6-
77
enum ResetFrequency: string
88
{
99
case Yearly = 'yearly';

‎src/Models/SequencePeriod.php

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence\Models;
56

7+
use Guava\Sequence\Database\Factories\SequencePeriodFactory;
68
use Illuminate\Database\Eloquent\Factories\HasFactory;
79
use Illuminate\Database\Eloquent\Model;
8-
use Guava\Sequence\Database\Factories\SequencePeriodFactory;
910

1011
/**
11-
* @property string $date
12-
* @property int $ordinal_number
12+
* @property string $date
13+
* @property int $ordinal_number
1314
*/
1415
class SequencePeriod extends Model
1516
{
@@ -28,15 +29,15 @@ protected static function newFactory()
2829
}
2930

3031
/**
31-
* @var array<string>
32+
* @var array<string>
3233
*/
3334
protected $fillable = [
3435
'date',
3536
'ordinal_number',
3637
];
3738

3839
/**
39-
* @var array<string, string>
40+
* @var array<string, string>
4041
*/
4142
protected $casts = [
4243
'ordinal_number' => 'integer',

‎src/Models/SequenceRule.php

+7-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence\Models;
56

7+
use Guava\Sequence\Database\Factories\SequenceRuleFactory;
8+
use Guava\Sequence\Enums\ResetFrequency;
69
use Illuminate\Database\Eloquent\Factories\HasFactory;
710
use Illuminate\Database\Eloquent\Model;
811
use Illuminate\Database\Eloquent\Relations\HasMany;
9-
use Guava\Sequence\Database\Factories\SequenceRuleFactory;
10-
use Guava\Sequence\Enums\ResetFrequency;
1112

1213
/**
13-
* @property string $pattern
14-
* @property string $reset_frequency
14+
* @property string $pattern
15+
* @property string $reset_frequency
1516
*/
1617
class SequenceRule extends Model
1718
{
@@ -20,7 +21,7 @@ class SequenceRule extends Model
2021
public $table = 'sequence_rules';
2122

2223
/**
23-
* @var array<string>
24+
* @var array<string>
2425
*/
2526
protected $fillable = [
2627
'type',
@@ -40,8 +41,6 @@ protected static function newFactory()
4041

4142
/**
4243
* Get the related periods.
43-
*
44-
* @return \Illuminate\Database\Eloquent\Relations\HasMany
4544
*/
4645
public function periods(): HasMany
4746
{
@@ -50,8 +49,6 @@ public function periods(): HasMany
5049

5150
/**
5251
* Decide whether ordinal number needs to be reset yearly.
53-
*
54-
* @return bool
5552
*/
5653
public function needsYearlyReset(): bool
5754
{
@@ -64,8 +61,6 @@ public function needsYearlyReset(): bool
6461

6562
/**
6663
* Decide whether ordinal number needs to be reset monthly.
67-
*
68-
* @return bool
6964
*/
7065
public function needsMonthlyReset(): bool
7166
{
@@ -77,13 +72,11 @@ public function needsMonthlyReset(): bool
7772

7873
/**
7974
* Decide whether ordinal number needs to be reset daily.
80-
*
81-
* @return bool
8275
*/
8376
public function needsDailyReset(): bool
8477
{
8578
return in_array(ResetFrequency::tryFrom($this->reset_frequency), [
86-
ResetFrequency::Daily
79+
ResetFrequency::Daily,
8780
]);
8881
}
8982
}

‎src/Sequence.php

+18-29
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence;
@@ -12,30 +13,26 @@ class Sequence
1213
/**
1314
* The period instance to use on sequence.
1415
*
15-
* @var \Guava\Sequence\Models\SequencePeriod
16+
* @var \Guava\Sequence\Models\SequencePeriod
1617
*/
1718
protected $period;
1819

1920
/**
2021
* The date to use on sequence.
2122
*
22-
* @var DateTimeInterface
23+
* @var DateTimeInterface
2324
*/
2425
protected $date;
2526

2627
/**
2728
* The number pattern to use on sequence.
2829
*
29-
* @var string
30+
* @var string
3031
*/
3132
protected $pattern;
3233

3334
/**
3435
* The sequence constructor.
35-
*
36-
* @param \Guava\Sequence\Models\SequencePeriod $period
37-
* @param string $pattern
38-
* @param DateTimeInterface $date
3936
*/
4037
public function __construct(SequencePeriod $period, string $pattern, DateTimeInterface $date)
4138
{
@@ -46,29 +43,27 @@ public function __construct(SequencePeriod $period, string $pattern, DateTimeInt
4643

4744
/**
4845
* Get the sequence number.
49-
*
50-
* @return string
5146
*/
5247
public function getNumber(bool $increment = false): string
5348
{
54-
// dd(str($this->getPattern())
55-
// ->pipe(fn(Stringable $str) => str(strtr($str->toString(), [
56-
// '{number}' => $this->getOrdinalNumber(),
57-
// '{day}' => $this->date->format('d'),
58-
// '{month}' => $this->date->format('m'),
59-
// '{year}' => $this->date->format('Y'),
60-
// '{day_short}' => $this->date->format('j'),
61-
// '{month_short}' => $this->date->format('n'),
62-
// '{year_short}' => $this->date->format('y'),
63-
// ]))));
49+
// dd(str($this->getPattern())
50+
// ->pipe(fn(Stringable $str) => str(strtr($str->toString(), [
51+
// '{number}' => $this->getOrdinalNumber(),
52+
// '{day}' => $this->date->format('d'),
53+
// '{month}' => $this->date->format('m'),
54+
// '{year}' => $this->date->format('Y'),
55+
// '{day_short}' => $this->date->format('j'),
56+
// '{month_short}' => $this->date->format('n'),
57+
// '{year_short}' => $this->date->format('y'),
58+
// ]))));
6459
$result = strtr(
6560
str($this->getPattern())
6661
->replaceMatches(
6762
'/\{number:(\d+)\}/',
68-
fn($matches) => str_pad(
69-
(string)$this->getOrdinalNumber(),
70-
(int)$matches[1],
71-
"0",
63+
fn ($matches) => str_pad(
64+
(string) $this->getOrdinalNumber(),
65+
(int) $matches[1],
66+
'0',
7267
STR_PAD_LEFT
7368
)
7469
)
@@ -93,8 +88,6 @@ public function getNumber(bool $increment = false): string
9388

9489
/**
9590
* Get the ordinal number of sequence.
96-
*
97-
* @return int
9891
*/
9992
public function getOrdinalNumber(bool $increment = false): int
10093
{
@@ -109,8 +102,6 @@ public function getOrdinalNumber(bool $increment = false): int
109102

110103
/**
111104
* Get the pattern of sequence.
112-
*
113-
* @return string
114105
*/
115106
public function getPattern(): string
116107
{
@@ -119,8 +110,6 @@ public function getPattern(): string
119110

120111
/**
121112
* Increment ordinal number of period.
122-
*
123-
* @return void
124113
*/
125114
public function increment(): void
126115
{

‎src/SequenceFactory.php

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
declare(strict_types=1);
34

45
namespace Guava\Sequence;
@@ -11,14 +12,12 @@ class SequenceFactory
1112
/**
1213
* The instance of sequence query helper.
1314
*
14-
* @var \Guava\Sequence\SequenceQuery
15+
* @var \Guava\Sequence\SequenceQuery
1516
*/
1617
protected $query;
1718

1819
/**
1920
* The sequence factory constructor.
20-
*
21-
* @param \Guava\Sequence\SequenceQuery $query
2221
*/
2322
public function __construct(SequenceQuery $query)
2423
{
@@ -27,10 +26,6 @@ public function __construct(SequenceQuery $query)
2726

2827
/**
2928
* Create instance of sequence.
30-
*
31-
* @param string $type
32-
* @param DateTimeInterface $date
33-
* @return \Guava\Sequence\Sequence
3429
*/
3530
public function create(string $type, DateTimeInterface $date): Sequence
3631
{

0 commit comments

Comments
 (0)