MichaelRubel\Couponables\Models\Coupon

Complexity

Total Complexity

22

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	2

13 Methods

Rating	Name	Duplication	Size	Complexity
A	isAllowedToRedeemBy()	0	11	5
A	for()	0	11	1
A	isOverQuantity()	0	5	2
A	__construct()	0	5	1
A	isNotExpired()	0	3	1
A	newFactory()	0	3	1
A	isExpired()	0	5	2
A	isRedeemedBy()	0	5	1
A	isOverLimit()	0	4	3
A	isOverLimitFor()	0	9	2
A	isEnabled()	0	3	1
A	isDisabled()	0	3	1
A	isDisposable()	0	3	1

<?php

declare(strict_types=1);

namespace MichaelRubel\Couponables\Models;

use Carbon\CarbonInterface;

The type Carbon\CarbonInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use MichaelRubel\Couponables\Models\Contracts\CouponContract;
use MichaelRubel\Couponables\Models\Factories\CouponFactory;
use MichaelRubel\Couponables\Models\Traits\DefinesColumnChecks;
use MichaelRubel\Couponables\Models\Traits\DefinesColumns;
use MichaelRubel\Couponables\Models\Traits\DefinesModelRelations;
use MichaelRubel\Couponables\Traits\Concerns\CalculatesCosts;

/**
 * "Coupon code" model class.
 *
 * @property string $code
 * @property string|null $type
 * @property string|null $value
 * @property bool $is_enabled
 * @property Collection|null $data
 * @property int|null $quantity
 * @property int|null $limit
 * @property string|null $redeemer_type
 * @property int|null $redeemer_id
 * @property CarbonInterface|null $expires_at
 */
class Coupon extends Model implements CouponContract
{
    use CalculatesCosts;
    use DefinesColumnChecks;
    use DefinesColumns;
    use DefinesModelRelations;
    use HasFactory;

    /**
     * The attributes that aren't mass assignable.
     *
     * @var array<string>|bool
     */
    protected $guarded = [];

    /**
     * The attributes that should be cast.
     *
     * @var array<string, string>
     */
    protected $casts = [
        'code'       => 'string',
        'type'       => 'string',
        'value'      => 'string',
        'is_enabled' => 'boolean',
        'data'       => 'collection',
        'quantity'   => 'integer',
        'limit'      => 'integer',
        'expires_at' => 'datetime',
    ];

    /**
     * @param  array  $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->table = config('couponables.table', 'coupons');
    }

    /**
     * Check if code is expired.
     *
     * @return bool
     */
    public function isExpired(): bool
    {
        $expires_at = $this->{static::getExpiresAtColumn()};

The method MichaelRubel\Couponables\Models\Coupon::getExpiresAtColumn() is not static, but was called statically.

        return $expires_at && now()->gte($expires_at);
    }

    /**
     * Check if code is not expired.
     *
     * @return bool
     */
    public function isNotExpired(): bool
    {
        return ! $this->isExpired();
    }

    /**
     * Check if code is enabled.
     *
     * @return bool
     */
    public function isEnabled(): bool
    {
        return $this->{static::getIsEnabledColumn()} ?? true;

The method MichaelRubel\Couponables\Models\Coupon::getIsEnabledColumn() is not static, but was called statically.

    }

    /**
     * Check if code is disabled.
     *
     * @return bool
     */
    public function isDisabled(): bool
    {
        return ! $this->isEnabled();
    }

    /**
     * Check if code amount is over.
     *
     * @return bool
     */
    public function isOverQuantity(): bool
    {
        $quantity = $this->{static::getQuantityColumn()};

The method MichaelRubel\Couponables\Models\Coupon::getQuantityColumn() is not static, but was called statically.

        return ! is_null($quantity) && $quantity <= 0;
    }

    /**
     * Check if coupon is disposable.
     *
     * @return bool
     */
    public function isDisposable(): bool
    {
        return $this->{static::getLimitColumn()} == 1;

The method MichaelRubel\Couponables\Models\Coupon::getLimitColumn() is not static, but was called statically.

    }

    /**
     * Check if the code is reached its global limit.
     *
     * @param  Model  $redeemer
     *
     * @return bool
     */
    public function isOverLimit(Model $redeemer): bool
    {
        return ($this->isDisposable() && $redeemer->isCouponAlreadyUsed($this->{static::getCodeColumn()}))

The method MichaelRubel\Couponables\Models\Coupon::getCodeColumn() is not static, but was called statically.

            || $this->isOverLimitFor($redeemer);
    }

    /**
     * Check if the code is reached its limit for the passed model.
     *
     * @param  Model  $redeemer
     *
     * @return bool
     */
    public function isOverLimitFor(Model $redeemer): bool
    {
        $column = static::getCodeColumn();

The method MichaelRubel\Couponables\Models\Coupon::getCodeColumn() is not static, but was called statically.

        $limit  = $this->{static::getLimitColumn()};

The method MichaelRubel\Couponables\Models\Coupon::getLimitColumn() is not static, but was called statically.

        return ! is_null($limit) && $limit <= $redeemer
            ->coupons()
            ->where($column, $this->{$column})
            ->count();
    }

    /**
     * Check if coupon is already redeemed by the model.
     *
     * @param  Model  $redeemer
     *
     * @return bool
     */
    public function isRedeemedBy(Model $redeemer): bool
    {
        $column = static::getCodeColumn();

The method MichaelRubel\Couponables\Models\Coupon::getCodeColumn() is not static, but was called statically.

        return $redeemer->coupons()->where($column, $this->{$column})->exists();
    }

    /**
     * Check if the model is allowed to redeem.
     *
     * @param  Model  $redeemer
     *
     * @return bool
     */
    public function isAllowedToRedeemBy(Model $redeemer): bool
    {
        if ($this->isMorphColumnsFilled() && ! $this->redeemer?->is($redeemer)) {

The property redeemer does not exist on MichaelRubel\Couponables\Models\Coupon. Did you mean redeemer_type?

            return false;
        }

        if ($this->isOnlyRedeemerTypeFilled() && ! $this->isSameRedeemerModel($redeemer)) {
            return false;
        }

        return true;
    }

    /**
     * Assign the model to the latest redeemed coupon.
     *
     * @param  Model  $redeemed
     *
     * @return CouponContract
     */
    public function for(Model $redeemed): CouponContract
    {
        return with($this->couponables()->first(), function ($couponable) use ($redeemed) {
            $morphValues = transform($couponable, fn ($bindable) => [
                $bindable->getRedeemedTypeColumn() => $redeemed->getMorphClass(),
                $bindable->getRedeemedIdColumn()   => $redeemed->id,
            ]);

            $couponable->update($morphValues);

            return $this;
        });
    }

    /**
     * Create a new factory instance for the model.
     *
     * @return Factory<Coupon>
     */
    protected static function newFactory(): Factory
    {
        return CouponFactory::new();
    }
}