style: fix code styling

GuavaCZ · Sep 5, 2024 · 2930e8e · 2930e8e
1 parent bbfc48b
commit 2930e8e
Show file tree

Hide file tree

Showing 15 changed files with 84 additions and 114 deletions.
diff --git a/database/factories/SequencePeriodFactory.php b/database/factories/SequencePeriodFactory.php
@@ -1,10 +1,11 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence\Database\Factories;
 
-use Illuminate\Database\Eloquent\Factories\Factory;
 use Guava\Sequence\Models\SequencePeriod;
+use Illuminate\Database\Eloquent\Factories\Factory;
 
 class SequencePeriodFactory extends Factory
 {
@@ -23,7 +24,7 @@ class SequencePeriodFactory extends Factory
     public function definition()
     {
         return [
-            'date'           => $this->faker->dateTimeBetween('-1 year')->format('Y-m-d'),
+            'date' => $this->faker->dateTimeBetween('-1 year')->format('Y-m-d'),
             'ordinal_number' => $this->faker->numberBetween(1, 100),
         ];
     }

diff --git a/database/factories/SequenceRuleFactory.php b/database/factories/SequenceRuleFactory.php
@@ -1,12 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence\Database\Factories;
 
-use Illuminate\Database\Eloquent\Factories\Factory;
-use InvalidArgumentException;
 use Guava\Sequence\Enums\ResetFrequency;
 use Guava\Sequence\Models\SequenceRule;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use InvalidArgumentException;
 
 class SequenceRuleFactory extends Factory
 {
@@ -25,9 +26,9 @@ class SequenceRuleFactory extends Factory
     public function definition()
     {
         return [
-            'type'            => $this->faker->unique()->word(),
+            'type' => $this->faker->unique()->word(),
             'reset_frequency' => $this->faker->randomElement(ResetFrequency::getValues()),
-            'pattern'         => function (array $attributes) {
+            'pattern' => function (array $attributes) {
                 return $this->faker->randomElement(
                     $this->examplePatterns($attributes['reset_frequency'])
                 );
@@ -38,8 +39,7 @@ public function definition()
     /**
      * Get example patterns for given reset frequency
      *
-     * @param   string  $resetFrequency
-     * @return  array<string>
+     * @return array<string>
      */
     private function examplePatterns(string $resetFrequency): array
     {
@@ -59,8 +59,6 @@ private function examplePatterns(string $resetFrequency): array
 
     /**
      * Indicate that sequence should resets daily.
-     *
-     * @return  \Illuminate\Database\Eloquent\Factories\Factory
      */
     public function resetsDaily(): Factory
     {
@@ -73,8 +71,6 @@ public function resetsDaily(): Factory
 
     /**
      * Indicate that sequence should resets monthly.
-     *
-     * @return  \Illuminate\Database\Eloquent\Factories\Factory
      */
     public function resetsMonthly(): Factory
     {
@@ -87,8 +83,6 @@ public function resetsMonthly(): Factory
 
     /**
      * Indicate that sequence should resets yearly.
-     *
-     * @return  \Illuminate\Database\Eloquent\Factories\Factory
      */
     public function resetsYearly(): Factory
     {

diff --git a/database/migrations/2021_06_01_100000_create_sequence_rules_table.php b/database/migrations/2021_06_01_100000_create_sequence_rules_table.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Illuminate\Database\Migrations\Migration;

diff --git a/database/migrations/2021_06_01_200000_create_sequence_periods_table.php b/database/migrations/2021_06_01_200000_create_sequence_periods_table.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 use Illuminate\Database\Migrations\Migration;
@@ -17,7 +18,8 @@ public function up()
         Schema::create('sequence_periods', function (Blueprint $table) {
             $table->id();
             $table->foreignId('rule_id')->constrained('sequence_rules')
-                ->cascadeOnUpdate()->restrictOnDelete();
+                ->cascadeOnUpdate()->restrictOnDelete()
+            ;
             $table->date('date');
             $table->unsignedInteger('ordinal_number');
             $table->timestamps();

diff --git a/src/Enums/ResetFrequency.php b/src/Enums/ResetFrequency.php
@@ -1,9 +1,9 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence\Enums;
 
-
 enum ResetFrequency: string
 {
     case Yearly = 'yearly';

diff --git a/src/Models/SequencePeriod.php b/src/Models/SequencePeriod.php
@@ -1,15 +1,16 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence\Models;
 
+use Guava\Sequence\Database\Factories\SequencePeriodFactory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
-use Guava\Sequence\Database\Factories\SequencePeriodFactory;
 
 /**
- * @property  string  $date
- * @property  int     $ordinal_number
+ * @property string $date
+ * @property int $ordinal_number
  */
 class SequencePeriod extends Model
 {
@@ -28,15 +29,15 @@ protected static function newFactory()
     }
 
     /**
-     * @var  array<string>
+     * @var array<string>
      */
     protected $fillable = [
         'date',
         'ordinal_number',
     ];
 
     /**
-     * @var  array<string, string>
+     * @var array<string, string>
      */
     protected $casts = [
         'ordinal_number' => 'integer',

diff --git a/src/Models/SequenceRule.php b/src/Models/SequenceRule.php
@@ -1,17 +1,18 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence\Models;
 
+use Guava\Sequence\Database\Factories\SequenceRuleFactory;
+use Guava\Sequence\Enums\ResetFrequency;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
-use Guava\Sequence\Database\Factories\SequenceRuleFactory;
-use Guava\Sequence\Enums\ResetFrequency;
 
 /**
- * @property  string $pattern
- * @property  string $reset_frequency
+ * @property string $pattern
+ * @property string $reset_frequency
  */
 class SequenceRule extends Model
 {
@@ -20,7 +21,7 @@ class SequenceRule extends Model
     public $table = 'sequence_rules';
 
     /**
-     * @var  array<string>
+     * @var array<string>
      */
     protected $fillable = [
         'type',
@@ -40,8 +41,6 @@ protected static function newFactory()
 
     /**
      * Get the related periods.
-     *
-     * @return  \Illuminate\Database\Eloquent\Relations\HasMany
      */
     public function periods(): HasMany
     {
@@ -50,8 +49,6 @@ public function periods(): HasMany
 
     /**
      * Decide whether ordinal number needs to be reset yearly.
-     *
-     * @return  bool
      */
     public function needsYearlyReset(): bool
     {
@@ -64,8 +61,6 @@ public function needsYearlyReset(): bool
 
     /**
      * Decide whether ordinal number needs to be reset monthly.
-     *
-     * @return  bool
      */
     public function needsMonthlyReset(): bool
     {
@@ -77,13 +72,11 @@ public function needsMonthlyReset(): bool
 
     /**
      * Decide whether ordinal number needs to be reset daily.
-     *
-     * @return  bool
      */
     public function needsDailyReset(): bool
     {
         return in_array(ResetFrequency::tryFrom($this->reset_frequency), [
-            ResetFrequency::Daily
+            ResetFrequency::Daily,
         ]);
     }
 }
diff --git a/src/Sequence.php b/src/Sequence.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence;
@@ -12,30 +13,26 @@ class Sequence
     /**
      * The period instance to use on sequence.
      *
-     * @var  \Guava\Sequence\Models\SequencePeriod
+     * @var \Guava\Sequence\Models\SequencePeriod
      */
     protected $period;
 
     /**
      * The date to use on sequence.
      *
-     * @var  DateTimeInterface
+     * @var DateTimeInterface
      */
     protected $date;
 
     /**
      * The number pattern to use on sequence.
      *
-     * @var  string
+     * @var string
      */
     protected $pattern;
 
     /**
      * The sequence constructor.
-     *
-     * @param \Guava\Sequence\Models\SequencePeriod $period
-     * @param string $pattern
-     * @param DateTimeInterface $date
      */
     public function __construct(SequencePeriod $period, string $pattern, DateTimeInterface $date)
     {
@@ -46,29 +43,27 @@ public function __construct(SequencePeriod $period, string $pattern, DateTimeInt
 
     /**
      * Get the sequence number.
-     *
-     * @return  string
      */
     public function getNumber(bool $increment = false): string
     {
-//        dd(str($this->getPattern())
-//            ->pipe(fn(Stringable $str) => str(strtr($str->toString(), [
-//            '{number}'      => $this->getOrdinalNumber(),
-//            '{day}'         => $this->date->format('d'),
-//            '{month}'       => $this->date->format('m'),
-//            '{year}'        => $this->date->format('Y'),
-//            '{day_short}'   => $this->date->format('j'),
-//            '{month_short}' => $this->date->format('n'),
-//            '{year_short}'  => $this->date->format('y'),
-//        ]))));
+        //        dd(str($this->getPattern())
+        //            ->pipe(fn(Stringable $str) => str(strtr($str->toString(), [
+        //            '{number}'      => $this->getOrdinalNumber(),
+        //            '{day}'         => $this->date->format('d'),
+        //            '{month}'       => $this->date->format('m'),
+        //            '{year}'        => $this->date->format('Y'),
+        //            '{day_short}'   => $this->date->format('j'),
+        //            '{month_short}' => $this->date->format('n'),
+        //            '{year_short}'  => $this->date->format('y'),
+        //        ]))));
         $result = strtr(
             str($this->getPattern())
                 ->replaceMatches(
                     '/\{number:(\d+)\}/',
-                    fn($matches) => str_pad(
-                        (string)$this->getOrdinalNumber(),
-                        (int)$matches[1],
-                        "0",
+                    fn ($matches) => str_pad(
+                        (string) $this->getOrdinalNumber(),
+                        (int) $matches[1],
+                        '0',
                         STR_PAD_LEFT
                     )
                 )
@@ -93,8 +88,6 @@ public function getNumber(bool $increment = false): string
 
     /**
      * Get the ordinal number of sequence.
-     *
-     * @return  int
      */
     public function getOrdinalNumber(bool $increment = false): int
     {
@@ -109,8 +102,6 @@ public function getOrdinalNumber(bool $increment = false): int
 
     /**
      * Get the pattern of sequence.
-     *
-     * @return  string
      */
     public function getPattern(): string
     {
@@ -119,8 +110,6 @@ public function getPattern(): string
 
     /**
      * Increment ordinal number of period.
-     *
-     * @return  void
      */
     public function increment(): void
     {

diff --git a/src/SequenceFactory.php b/src/SequenceFactory.php
@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Guava\Sequence;
@@ -11,14 +12,12 @@ class SequenceFactory
     /**
      * The instance of sequence query helper.
      *
-     * @var  \Guava\Sequence\SequenceQuery
+     * @var \Guava\Sequence\SequenceQuery
      */
     protected $query;
 
     /**
      * The sequence factory constructor.
-     *
-     * @param  \Guava\Sequence\SequenceQuery  $query
      */
     public function __construct(SequenceQuery $query)
     {
@@ -27,10 +26,6 @@ public function __construct(SequenceQuery $query)
 
     /**
      * Create instance of sequence.
-     *
-     * @param   string             $type
-     * @param   DateTimeInterface  $date
-     * @return  \Guava\Sequence\Sequence
      */
     public function create(string $type, DateTimeInterface $date): Sequence
     {