MichaelRubel\Couponables\Models\Coupon

Complexity

Total Complexity

12

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isOverQuantity()	0	5	2
A	__construct()	0	5	1
A	isNotExpired()	0	3	1
A	isExpired()	0	5	2
A	redeemer()	0	5	2
A	isRedeemedBy()	0	9	2
A	isOverLimitFor()	0	5	2

<?php

declare(strict_types=1);

namespace MichaelRubel\Couponables\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use MichaelRubel\Couponables\Models\Contracts\CouponContract;
use MichaelRubel\Couponables\Models\Traits\DefinesColumns;

class Coupon extends Model implements CouponContract
{
    use HasFactory, DefinesColumns;

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

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

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

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

    /**
     * @return Model|null
     */
    public function redeemer(): ?Model
    {
        return $this->isMorphColumnsFilled()
            ? $this->morphTo()->first()
            : null;
    }

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

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

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

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

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

    /**
     * Check if coupon is already redeemed by the model.
     *
     * @param Model $redeemer
     *
     * @return bool
     */
    public function isRedeemedBy(Model $redeemer): bool
    {
        $column = call(CouponContract::class)->getCodeColumn();
        $code   = $this->{$column};

        return ! is_null($code) && $redeemer
            ->coupons()
            ->where($column, $code)
            ->exists();
    }

    /**
     * Check if code is for one-time use.
     *
     * @param Model $redeemer
     *
     * @return bool
     */
    public function isOverLimitFor(Model $redeemer): bool
    {
        $limit = $this->{call(CouponContract::class)->getLimitColumn()};

        return ! is_null($limit) && $limit <= $redeemer->coupons()->count();
    }
}