Stop using enums

Author: lucasdotvin

README.md

@@ -73,7 +73,7 @@ class FeatureSeeder extends Seeder
         $deployMinutes = Feature::create([
             'consumable'       => true,
             'name'             => 'deploy-minutes',
-            'periodicity_type' => PeriodicityType::Day->name,
+            'periodicity_type' => PeriodicityType::Day,
             'periodicity'      => 1,
         ]);
 
@@ -85,7 +85,7 @@ class FeatureSeeder extends Seeder
 }
 ```
 
-By saying the `deploy-minutes` is a consumable feature, we are telling the users can use it a limited number of times (or until a given amount). On the other hand, by passing `PeriodicityType::Day->name` and 1 as its `periodicity_type` and `periodicity` respectively, we said that it should be renewed everyday. So a user could spend his minutes today and have it back tomorrow, for instance.
+By saying the `deploy-minutes` is a consumable feature, we are telling the users can use it a limited number of times (or until a given amount). On the other hand, by passing `PeriodicityType::Day` and 1 as its `periodicity_type` and `periodicity` respectively, we said that it should be renewed everyday. So a user could spend his minutes today and have it back tomorrow, for instance.
 
 > It is important to keep in mind that both plans and consumable features have its periodicity, so your users can, for instance, have a monthly plan with weekly features.
 
@@ -110,13 +110,13 @@ class PlanSeeder extends Seeder
     {
         $silver = Plan::create([
             'name'             => 'silver',
-            'periodicity_type' => PeriodicityType::Month->name,
+            'periodicity_type' => PeriodicityType::Month,
             'periodicity'      => 1,
         ]);
 
         $gold = Plan::create([
             'name'             => 'gold',
-            'periodicity_type' => PeriodicityType::Month->name,
+            'periodicity_type' => PeriodicityType::Month,
             'periodicity'      => 1,
         ]);
     }

database/factories/FeatureFactory.php

@@ -22,10 +22,10 @@ public function definition()
             'name'             => $this->faker->words(asText: true),
             'periodicity'      => $this->faker->randomDigitNotZero(),
             'periodicity_type' => $this->faker->randomElement([
-                PeriodicityType::Year->name,
-                PeriodicityType::Month->name,
-                PeriodicityType::Week->name,
-                PeriodicityType::Day->name,
+                PeriodicityType::Year,
+                PeriodicityType::Month,
+                PeriodicityType::Week,
+                PeriodicityType::Day,
             ]),
         ];
     }

database/factories/PlanFactory.php

@@ -21,10 +21,10 @@ public function definition()
             'name'             => $this->faker->words(asText: true),
             'periodicity'      => $this->faker->randomDigitNotZero(),
             'periodicity_type' => $this->faker->randomElement([
-                PeriodicityType::Year->name,
-                PeriodicityType::Month->name,
-                PeriodicityType::Week->name,
-                PeriodicityType::Day->name,
+                PeriodicityType::Year,
+                PeriodicityType::Month,
+                PeriodicityType::Week,
+                PeriodicityType::Day,
             ]),
         ];
     }

src/Enums/PeriodicityType.php

@@ -5,17 +5,19 @@
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Str;
 
-enum PeriodicityType
+class PeriodicityType
 {
-    case Year;
-    case Month;
-    case Week;
-    case Day;
+    public const Year = 'Year';
 
-    public static function getDateDifference(Carbon $from, Carbon $to, string|PeriodicityType $unit): int
+    public const Month = 'Month';
+
+    public const Week = 'Week';
+
+    public const Day = 'Day';
+
+    public static function getDateDifference(Carbon $from, Carbon $to, string $unit): int
     {
-        $unitName = $unit->name ?? $unit;
-        $unitInPlural = Str::plural($unitName);
+        $unitInPlural = Str::plural($unit);
 
         $differenceMethodName = 'diffIn' . $unitInPlural;
 

tests/Models/FeatureTest.php

@@ -20,7 +20,7 @@ public function testModelCalculateYearlyExpiration()
 
         $years = $this->faker->randomDigitNotZero();
         $feature = Feature::factory()->create([
-            'periodicity_type' => PeriodicityType::Year->name,
+            'periodicity_type' => PeriodicityType::Year,
             'periodicity' => $years,
         ]);
 
@@ -33,7 +33,7 @@ public function testModelCalculateMonthlyExpiration()
 
         $months = $this->faker->randomDigitNotZero();
         $feature = Feature::factory()->create([
-            'periodicity_type' => PeriodicityType::Month->name,
+            'periodicity_type' => PeriodicityType::Month,
             'periodicity' => $months,
         ]);
 
@@ -46,7 +46,7 @@ public function testModelCalculateWeeklyExpiration()
 
         $weeks = $this->faker->randomDigitNotZero();
         $feature = Feature::factory()->create([
-            'periodicity_type' => PeriodicityType::Week->name,
+            'periodicity_type' => PeriodicityType::Week,
             'periodicity' => $weeks,
         ]);
 
@@ -59,7 +59,7 @@ public function testModelCalculateDailyExpiration()
 
         $days = $this->faker->randomDigitNotZero();
         $feature = Feature::factory()->create([
-            'periodicity_type' => PeriodicityType::Day->name,
+            'periodicity_type' => PeriodicityType::Day,
             'periodicity' => $days,
         ]);
 
@@ -71,7 +71,7 @@ public function testModelcalculateNextRecurrenceEndConsideringRecurrences()
         Carbon::setTestNow(now());
 
         $feature = Feature::factory()->create([
-            'periodicity_type' => PeriodicityType::Week->name,
+            'periodicity_type' => PeriodicityType::Week,
             'periodicity' => 1,
         ]);
 

tests/Models/PlanTest.php

@@ -20,7 +20,7 @@ public function testModelCalculateYearlyExpiration()
 
         $years = $this->faker->randomDigitNotZero();
         $plan = Plan::factory()->create([
-            'periodicity_type' => PeriodicityType::Year->name,
+            'periodicity_type' => PeriodicityType::Year,
             'periodicity' => $years,
         ]);
 
@@ -33,7 +33,7 @@ public function testModelCalculateMonthlyExpiration()
 
         $months = $this->faker->randomDigitNotZero();
         $plan = Plan::factory()->create([
-            'periodicity_type' => PeriodicityType::Month->name,
+            'periodicity_type' => PeriodicityType::Month,
             'periodicity' => $months,
         ]);
 
@@ -46,7 +46,7 @@ public function testModelCalculateWeeklyExpiration()
 
         $weeks = $this->faker->randomDigitNotZero();
         $plan = Plan::factory()->create([
-            'periodicity_type' => PeriodicityType::Week->name,
+            'periodicity_type' => PeriodicityType::Week,
             'periodicity' => $weeks,
         ]);
 
@@ -59,7 +59,7 @@ public function testModelCalculateDailyExpiration()
 
         $days = $this->faker->randomDigitNotZero();
         $plan = Plan::factory()->create([
-            'periodicity_type' => PeriodicityType::Day->name,
+            'periodicity_type' => PeriodicityType::Day,
             'periodicity' => $days,
         ]);