Merge branch 'release/1.0.1' into main

Author: lucasdotvin

database/factories/FeatureConsumptionFactory.php

@@ -20,7 +20,7 @@ public function definition()
         return [
             'feature_id'  => Feature::factory(),
             'consumption' => $this->faker->randomFloat(),
-            'expires_at'  => $this->faker->dateTime(),
+            'expired_at'  => $this->faker->dateTime(),
         ];
     }
 }

database/factories/SubscriptionFactory.php

@@ -22,7 +22,7 @@ public function definition()
             'canceled_at'   => null,
             'started_at'    => $this->faker->dateTime(),
             'suppressed_at' => null,
-            'expires_at'    => $this->faker->dateTime(),
+            'expired_at'    => $this->faker->dateTime(),
             'was_switched'  => false,
         ];
     }
@@ -34,7 +34,7 @@ public function canceled()
         ]);
     }
 
-    public function uncanceled()
+    public function NotCanceled()
     {
         return $this->state(fn (array $attributes) => [
             'canceled_at' => null,
@@ -44,7 +44,7 @@ public function uncanceled()
     public function expired()
     {
         return $this->state(fn (array $attributes) => [
-            'expires_at' => $this->faker->dateTime(),
+            'expired_at' => $this->faker->dateTime(),
         ]);
     }
 
@@ -69,7 +69,7 @@ public function suppressed()
         ]);
     }
 
-    public function unsuppressed()
+    public function NotSuppressed()
     {
         return $this->state(fn (array $attributes) => [
             'suppressed_at' => null,

database/migrations/2022_02_01_235539_create_subscriptions_table.php

@@ -17,7 +17,7 @@ public function up()
             $table->id();
             $table->foreignIdFor(\LucasDotDev\Soulbscription\Models\Plan::class);
             $table->timestamp('canceled_at')->nullable();
-            $table->timestamp('expires_at');
+            $table->timestamp('expired_at');
             $table->date('started_at');
             $table->timestamp('suppressed_at')->nullable();
             $table->boolean('was_switched')->default(false);

database/migrations/2022_02_02_000527_create_feature_consumptions_table.php

@@ -15,7 +15,7 @@ public function up()
         Schema::create('feature_consumptions', function (Blueprint $table) {
             $table->id();
             $table->unsignedDecimal('consumption')->nullable();
-            $table->timestamp('expires_at')->nullable();
+            $table->timestamp('expired_at')->nullable();
             $table->foreignIdFor(\LucasDotDev\Soulbscription\Models\Feature::class)->constrained()->cascadeOnDelete();
             $table->timestamps();
 

src/Models/Concerns/Expires.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace LucasDotDev\Soulbscription\Models\Concerns;
+
+use LucasDotDev\Soulbscription\Models\Scopes\ExpiringScope;
+
+trait Expires
+{
+    public static function bootExpires()
+    {
+        static::addGlobalScope(new ExpiringScope());
+    }
+
+    public function initializeExpires()
+    {
+        if (! isset($this->casts['expired_at'])) {
+            $this->casts['expired_at'] = 'datetime';
+        }
+    }
+
+    public function expired()
+    {
+        return ! is_null($this->expired_at);
+    }
+
+    public function notExpired()
+    {
+        return is_null($this->expired_at);
+    }
+}

src/Models/Concerns/HasSubscriptions.php

@@ -2,7 +2,6 @@
 
 namespace LucasDotDev\Soulbscription\Models\Concerns;
 
-use Illuminate\Database\Eloquent\Builder;
 use LucasDotDev\Soulbscription\Models\Feature;
 use LucasDotDev\Soulbscription\Models\FeatureConsumption;
 use LucasDotDev\Soulbscription\Models\Plan;
@@ -13,44 +12,19 @@
 
 trait HasSubscriptions
 {
-    public function activePlans()
-    {
-        return $this->plans()
-            ->wherePivot('expires_at', '>', now());
-    }
-
     public function featureConsumptions()
     {
         return $this->morphMany(FeatureConsumption::class, 'subscriber');
     }
 
-    public function plans()
-    {
-        return $this->belongsToMany(Plan::class, 'subscriptions', 'subscriber_id')
-            ->as('subscription')
-            ->withPivot([
-                'canceled_at',
-                'expires_at',
-                'started_at',
-                'suppressed_at',
-                'was_switched',
-            ])
-            ->withTimestamps();
-    }
-
     public function renewals()
     {
         return $this->hasManyThrough(SubscriptionRenewal::class, Subscription::class, 'subscriber_id');
     }
 
     public function subscription()
     {
-        return $this->morphOne(Subscription::class, 'subscriber')->ofMany(
-            [
-                'started_at' => 'max',
-            ],
-            fn (Builder $query) => $query->started(),
-        );
+        return $this->morphOne(Subscription::class, 'subscriber')->ofMany('started_at', 'MAX');
     }
 
     public function canConsume($featureName, ?float $consumption = null): bool
@@ -65,7 +39,6 @@ public function canConsume($featureName, ?float $consumption = null): bool
 
         $currentConsumption = $this->featureConsumptions()
             ->whereBelongsTo($feature)
-            ->unexpired()
             ->sum('consumption');
 
         return ($currentConsumption + $consumption) <= $feature->pivot->charges;
@@ -100,17 +73,16 @@ public function consume($featureName, ?float $consumption = null)
             'The feature has no enough charges to this consumption.',
         ));
 
-        $consumedPlan = $this->activePlans->first(fn (Plan $plan) => $plan->features->firstWhere('name', $featureName));
-        $feature = $consumedPlan->features->firstWhere('name', $featureName);
+        $feature = $this->subscription->plan->features->firstWhere('name', $featureName);
 
         $consumptionExpiration = $feature->consumable
-            ? $feature->calculateNextRecurrenceEnd($consumedPlan->subscription->started_at)
+            ? $feature->calculateNextRecurrenceEnd($this->subscription->started_at)
             : null;
 
         $this->featureConsumptions()
             ->make([
                 'consumption' => $consumption,
-                'expires_at' => $consumptionExpiration,
+                'expired_at' => $consumptionExpiration,
             ])
             ->feature()
             ->associate($feature)
@@ -123,12 +95,10 @@ public function subscribeTo(Plan $plan, $expiration = null, $startDate = null):
 
         return tap(
             $this->subscription()
-                ->make([
-                    'expires_at' => $expiration,
-                ])
+                ->make(['expired_at' => $expiration])
                 ->start($startDate)
                 ->plan()
-                ->associate($plan),
+                ->associate($plan)
         )->save();
     }
 
@@ -147,17 +117,20 @@ public function switchTo(Plan $plan, $expiration = null, $immediately = true): S
             ->markAsSwitched()
             ->save();
 
-        $startDate = $this->subscription->expires_at;
+        $startDate = $this->subscription->expired_at;
 
         return $this->subscribeTo($plan, startDate: $startDate);
     }
 
     private function getAvailableFeature(string $featureName): ?Feature
     {
-        $this->loadMissing('activePlans.features');
+        $this->loadMissing('subscription.plan.features');
+
+        if (empty($this->subscription)) {
+            return null;
+        }
 
-        $availableFeatures = $this->activePlans->flatMap(fn (Plan $plan) => $plan->features);
-        $feature = $availableFeatures->firstWhere('name', $featureName);
+        $feature = $this->subscription->plan->features->firstWhere('name', $featureName);
 
         return $feature;
     }

src/Models/Concerns/Starts.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LucasDotDev\Soulbscription\Models\Concerns;
+
+use Illuminate\Support\Carbon;
+use LucasDotDev\Soulbscription\Models\Scopes\StartingScope;
+
+trait Starts
+{
+    public static function bootStarts()
+    {
+        static::addGlobalScope(new StartingScope());
+    }
+
+    public function initializeStarts()
+    {
+        if (! isset($this->casts['started_at'])) {
+            $this->casts['started_at'] = 'datetime';
+        }
+    }
+
+    public function start(?Carbon $startDate = null)
+    {
+        return $this->fill([
+            'started_at' => $startDate ?: today(),
+        ]);
+    }
+
+    public function started()
+    {
+        return ! is_null($this->started_at);
+    }
+
+    public function notStarted()
+    {
+        return is_null($this->started_at);
+    }
+}

src/Models/Concerns/Suppresses.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace LucasDotDev\Soulbscription\Models\Concerns;
+
+use Illuminate\Support\Carbon;
+use LucasDotDev\Soulbscription\Models\Scopes\SuppressingScope;
+
+trait Suppresses
+{
+    public static function bootSuppresses()
+    {
+        static::addGlobalScope(new SuppressingScope());
+    }
+
+    public function initializeSuppresses()
+    {
+        if (! isset($this->casts['suppressed_at'])) {
+            $this->casts['suppressed_at'] = 'datetime';
+        }
+    }
+
+    public function suppress(?Carbon $suppressation = null)
+    {
+        return $this->fill([
+            'suppressed_at' => $suppressation ?: now(),
+        ]);
+    }
+
+    public function suppressed()
+    {
+        return ! is_null($this->suppressed_at);
+    }
+
+    public function notSuppressed()
+    {
+        return is_null($this->suppressed_at);
+    }
+}

src/Models/FeatureConsumption.php

@@ -2,21 +2,18 @@
 
 namespace LucasDotDev\Soulbscription\Models;
 
-use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
+use LucasDotDev\Soulbscription\Models\Concerns\Expires;
 
 class FeatureConsumption extends Model
 {
+    use Expires;
     use HasFactory;
 
-    protected $dates = [
-        'expires_at',
-    ];
-
     protected $fillable = [
         'consumption',
-        'expires_at',
+        'expired_at',
     ];
 
     public function feature()
@@ -28,14 +25,4 @@ public function subscriber()
     {
         return $this->morphTo('subscriber');
     }
-
-    public function scopeExpired(Builder $query)
-    {
-        return $query->where('expires_at', '<', now());
-    }
-
-    public function scopeUnexpired(Builder $query)
-    {
-        return $query->where('expires_at', '>', now());
-    }
 }