Fixed what needed fixing and squished some bugs. 🐛

abr4xas · abr4xas · commit 26cb69f3bd8a · 2022-07-22T18:52:56.000-03:00
diff --git a/composer.json b/composer.json
@@ -15,7 +15,8 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
+        "spatie/laravel-enum": "^3.0",
         "spatie/laravel-package-tools": "^1.11"
     },
     "require-dev": {
diff --git a/database/factories/LeadFactory.php b/database/factories/LeadFactory.php
@@ -3,27 +3,61 @@
 namespace Tepuilabs\SimpleCrm\Database\Factories;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Tepuilabs\SimpleCrm\Models\Enums\Lead\LeadStatus;
+use Tepuilabs\SimpleCrm\Models\Enums\Lead\LeadType;
+use Tepuilabs\SimpleCrm\Models\Lead;
 
 
 class LeadFactory extends Factory
 {
-    protected $model = \Tepuilabs\SimpleCrm\Models\Lead::class;
-
-    const ORGANIC_TYPE = 'Organic';
-    const USER_SUBMITTED_TYPE = 'User Submitted';
-
-    const PROSPECT_STATUS = 'Prospect';
-    const LEAD_STATUS = 'Lead';
-    const CUSTOMER_STATUS = 'Customer';
-
-
+    /**
+     * {@inheritdoc}
+     */
+    protected $model = Lead::class;
+
+    /**
+     * {@inheritdoc}
+     */
     public function definition()
     {
         return [
             'name' => $this->faker->name,
             'email' => $this->faker->email,
-            'type' => $this->faker->randomElement([self::ORGANIC_TYPE, self::USER_SUBMITTED_TYPE]),
-            'status' => $this->faker->randomElement([self::PROSPECT_STATUS, self::LEAD_STATUS, self::CUSTOMER_STATUS]),
         ];
     }
+
+    public function organicType(): LeadFactory
+    {
+        return $this->state([
+            'type' => LeadType::ORGANIC_TYPE(),
+        ]);
+    }
+
+    public function userSubmittedType(): LeadFactory
+    {
+        return $this->state([
+            'type' => LeadType::USER_SUBMITTED_TYPE(),
+        ]);
+    }
+
+    public function leadStatus(): LeadFactory
+    {
+        return $this->state([
+            'status' => LeadStatus::LEAD_STATUS()
+        ]);
+    }
+
+    public function prospectStatus(): LeadFactory
+    {
+        return $this->state([
+            'status' => LeadStatus::PROSPECT_STATUS()
+        ]);
+    }
+
+    public function customerStatus(): LeadFactory
+    {
+        return $this->state([
+            'status' => LeadStatus::CUSTOMER_STATUS()
+        ]);
+    }
 }
diff --git a/database/factories/NoteFactory.php b/database/factories/NoteFactory.php
@@ -3,29 +3,52 @@
 namespace Tepuilabs\SimpleCrm\Database\Factories;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Tepuilabs\SimpleCrm\Models\Enums\Note\NotePriority;
+use Tepuilabs\SimpleCrm\Models\Note;
 
 
 class NoteFactory extends Factory
 {
-    protected $model = \Tepuilabs\SimpleCrm\Models\Note::class;
-
-    const LOW_PRIORITY = 'Low';
-    const MEDIUM_PRIORITY = 'Medium';
-    const HIGH_PRIORITY = 'High';
-
-
+    /**
+     * {@inheritdoc}
+     */
+    protected $model = Note::class;
+
+    /**
+     * {@inheritdoc}
+     */
     public function definition()
     {
-        $author = \Tepuilabs\SimpleCrm\Tests\Models\User::factory()->create();
-        $lead = \Tepuilabs\SimpleCrm\Models\Lead::factory()->create();
+        $author = User::factory()->create();
+        $lead = Lead::factory()->create();
 
         return [
-            'priority' => $this->faker->randomElement([self::LOW_PRIORITY, self::MEDIUM_PRIORITY, self::HIGH_PRIORITY]),
             'title' => $this->faker->sentence($nbWords = 6, $variableNbWords = true),
             'body' => $this->faker->paragraphs($nb = 3, $asText = false),
             'lead_id' => $lead->id,
             'author_id' => $author->id,
             'author_type' => \Tepuilabs\SimpleCrm\Tests\Models\User::class,
         ];
     }
+
+    public function lowPriority(): NoteFactory
+    {
+        return $this->state([
+            'priority' => NotePriority::LOW_PRIORITY()
+        ]);
+    }
+
+    public function mediumPriority(): NoteFactory
+    {
+        return $this->state([
+            'priority' => NotePriority::MEDIUM_PRIORITY()
+        ]);
+    }
+
+    public function highPriority(): NoteFactory
+    {
+        return $this->state([
+            'priority' => NotePriority::HIGH_PRIORITY()
+        ]);
+    }
 }
diff --git a/database/factories/ServiceFactory.php b/database/factories/ServiceFactory.php
@@ -3,27 +3,29 @@
 namespace Tepuilabs\SimpleCrm\Database\Factories;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Model;
+use Tepuilabs\SimpleCrm\Models\Enums\StatusEnum;
+use Tepuilabs\SimpleCrm\Models\Service;
 
 class ServiceFactory extends Factory
 {
     /**
-     * The name of the factory's corresponding model.
-     *
-     * @var string
+     * {@inheritdoc}
      */
-    protected $model =  \Tepuilabs\SimpleCrm\Models\Service::class;
+    protected $model = Service::class;
 
     /**
-     * Define the model's default state.
-     *
-     * @return array
+     * {@inheritdoc}
      */
     public function definition()
     {
         return [
-            'name' => $this->faker->sentence($nbWords = 6, $variableNbWords = true),
-            'description' => $this->faker->sentence($nbWords = 6, $variableNbWords = true),
-            'status' => $this->faker->randomElement(['published', 'draft']),
+            'name' => $this->faker->sentence(6, true),
+            'description' => $this->faker->sentence(6, true),
+            'status' => $this->faker->randomElement([
+                StatusEnum::PUBLISHED(),
+                StatusEnum::DRAFT()
+            ]),
         ];
     }
 }
diff --git a/database/migrations/create_services_table.php.stub b/database/migrations/create_services_table.php.stub
@@ -17,7 +17,7 @@ class CreateServicesTable extends Migration
             $table->id();
             $table->string('name')->nullable();
             $table->text('description')->nullable();
-            $table->enum('status', ['published', 'draft'])->default('draft');
+            $table->enum('status', ['PUBLISHED', 'DRAFT'])->default('DRAFT');
             $table->timestamps();
             $table->softDeletes();
         });
diff --git a/src/Models/Enums/Lead/LeadStatus.php b/src/Models/Enums/Lead/LeadStatus.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Tepuilabs\SimpleCrm\Models\Enums\Lead;
+
+use Spatie\Enum\Laravel\Enum;
+
+/**
+ * @method static self PROSPECT_STATUS()
+ * @method static self LEAD_STATUS()
+ * @method static self CUSTOMER_STATUS()
+ */
+class LeadStatus extends Enum
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return match ($this->value) {
+            self::PROSPECT_STATUS()->value => 'prospect',
+            self::LEAD_STATUS()->value => 'lead',
+            self::CUSTOMER_STATUS()->value => 'customer',
+        };
+    }
+}
diff --git a/src/Models/Enums/Lead/LeadType.php b/src/Models/Enums/Lead/LeadType.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Tepuilabs\SimpleCrm\Models\Enums\Lead;
+
+use Spatie\Enum\Laravel\Enum;
+
+/**
+ * @method static self ORGANIC_TYPE()
+ * @method static self USER_SUBMITTED_TYPE()
+ */
+class LeadType extends Enum
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return match ($this->value) {
+            self::ORGANIC_TYPE()->value => 'organic',
+            self::USER_SUBMITTED_TYPE()->value => 'user submitted',
+        };
+    }
+}
diff --git a/src/Models/Enums/Note/NotePriority.php b/src/Models/Enums/Note/NotePriority.php
@@ -0,0 +1,24 @@
+<?php
+namespace Tepuilabs\SimpleCrm\Models\Enums\Note;
+
+use Spatie\Enum\Laravel\Enum;
+
+/**
+ * @method static self LOW_PRIORITY()
+ * @method static self MEDIUM_PRIORITY()
+ * @method static self HIGH_PRIORITY()
+ */
+class NotePriority extends Enum
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return match ($this->value) {
+            self::LOW_PRIORITY()->value => 'low',
+            self::MEDIUM_PRIORITY()->value => 'medium',
+            self::HIGH_PRIORITY()->value => 'high',
+        };
+    }
+}
diff --git a/src/Models/Enums/StatusEnum.php b/src/Models/Enums/StatusEnum.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Tepuilabs\SimpleCrm\Models\Enums;
+
+use Spatie\Enum\Laravel\Enum;
+
+/**
+ * @method static self DRAFT()
+ * @method static self PUBLISHED()
+ */
+class StatusEnum extends Enum
+{
+    /**
+     * @return string
+     */
+    public function label(): string
+    {
+        return match ($this->value) {
+            self::DRAFT()->value => 'DRAFT',
+            self::PUBLISHED()->value => 'PUBLISHED',
+        };
+    }
+}
diff --git a/src/Models/Lead.php b/src/Models/Lead.php
@@ -5,6 +5,8 @@
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Tepuilabs\SimpleCrm\Models\Enums\Lead\LeadStatus;
+use Tepuilabs\SimpleCrm\Models\Enums\Lead\LeadType;
 
 /**
  * @url https://www.hipb2b.com/blog/lead-prospect-whats-difference
@@ -13,17 +15,8 @@ class Lead extends Model
 {
     use HasFactory;
 
-    const ORGANIC_TYPE = 'Organic';
-    const USER_SUBMITTED_TYPE = 'User Submitted';
-
-    const PROSPECT_STATUS = 'Prospect';
-    const LEAD_STATUS = 'Lead';
-    const CUSTOMER_STATUS = 'Customer';
-
     /**
-     * The attributes that are mass assignable.
-     *
-     * @var array
+     * {@inheritdoc}
      */
     protected $fillable = [
         'name',
@@ -33,39 +26,20 @@ class Lead extends Model
     ];
 
     /**
-     * Notes relationship
-     *
-     * @return HasMany
+     * {@inheritdoc}
      */
-    public function notes(): HasMany
-    {
-        return $this->hasMany(\App\Models\Tepuilabs\SimpleCrm\Note::class);
-    }
-
-    /**
-     * Undocumented function
-     *
-     * @return array
-     */
-    public static function getTypes(): array
-    {
-        return [
-            self::ORGANIC_TYPE => self::ORGANIC_TYPE,
-            self::USER_SUBMITTED_TYPE => self::USER_SUBMITTED_TYPE,
-        ];
-    }
+    protected $casts = [
+        'status' => LeadStatus::class,
+        'type' => LeadType::class,
+    ];
 
     /**
-     * Undocumented function
+     * Notes relationship
      *
-     * @return array
+     * @return HasMany
      */
-    public static function getStatuses(): array
+    public function notes(): HasMany
     {
-        return [
-            self::PROSPECT_STATUS => self::PROSPECT_STATUS,
-            self::LEAD_STATUS => self::LEAD_STATUS,
-            self::CUSTOMER_STATUS => self::CUSTOMER_STATUS,
-        ];
+        return $this->hasMany(Note::class);
     }
 }
diff --git a/src/Models/Note.php b/src/Models/Note.php
diff --git a/src/Models/Service.php b/src/Models/Service.php
diff --git a/tests/Models/User.php b/tests/Models/User.php
diff --git a/tests/Unit/LeadTest.php b/tests/Unit/LeadTest.php
diff --git a/tests/Unit/NoteTest.php b/tests/Unit/NoteTest.php
