CouponService::performChecksOnRedeemer() - Code Metrics - Inspection of "Drop support of method bindings" - michael-rubel/laravel-couponables - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#26)

by Michael

created 2023-05-17 15:06 UTC

CouponService::performChecksOnRedeemer() A

↳ Parent: CouponService

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
eloc	7
c	0
b	0
f	0
dl	0
loc	15
ccs	8
cts	8
cp	1
rs	10
cc	3
nc	3
nop	2
crap	3

<?php

declare(strict_types=1);

namespace MichaelRubel\Couponables\Services;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Traits\Macroable;
use MichaelRubel\Couponables\Events\CouponDisabled;
use MichaelRubel\Couponables\Events\CouponExpired;
use MichaelRubel\Couponables\Events\CouponIsOverLimit;
use MichaelRubel\Couponables\Events\CouponIsOverQuantity;
use MichaelRubel\Couponables\Events\CouponRedeemed;
use MichaelRubel\Couponables\Events\CouponVerified;
use MichaelRubel\Couponables\Events\NotAllowedToRedeem;
use MichaelRubel\Couponables\Exceptions\CouponDisabledException;
use MichaelRubel\Couponables\Exceptions\CouponExpiredException;
use MichaelRubel\Couponables\Exceptions\InvalidCouponException;
use MichaelRubel\Couponables\Exceptions\NotAllowedToRedeemException;
use MichaelRubel\Couponables\Exceptions\OverLimitException;
use MichaelRubel\Couponables\Exceptions\OverQuantityException;
use MichaelRubel\Couponables\Models\Contracts\CouponContract;
use MichaelRubel\Couponables\Models\Contracts\CouponPivotContract;
use MichaelRubel\Couponables\Services\Contracts\CouponServiceContract;
use MichaelRubel\Couponables\Traits\Concerns\GeneratesCoupons;

class CouponService implements CouponServiceContract
{
    use Macroable, GeneratesCoupons;


    /**
     * @param  CouponContract  $model
     * @param  CouponPivotContract  $pivot
     */
    public function __construct(
        public CouponContract $model,
        public CouponPivotContract $pivot,
    ) {
    }

    /**
     * Get the coupon model by the code.
     *
     * @param  string|null  $code
     *
     * @return CouponContract|null
     */
    public function getCoupon(?string $code): ?CouponContract
    {
        return $this->model->firstWhere($this->model->getCodeColumn(), $code);
        return $this->model->/** @scrutinizer ignore-call */ firstWhere($this->model->getCodeColumn(), $code);
    }

    /**
     * Perform the stateless checks on the coupon
     * model. Redeemer is optional in this case.
     *
     * @param  CouponContract  $coupon
     * @param  Model|null  $redeemer
     *
     * @return CouponContract
     *
     * @throws CouponExpiredException
     * @throws OverQuantityException
     * @throws CouponDisabledException
     */
    public function performBasicChecks(CouponContract $coupon, ?Model $redeemer = null): CouponContract
    {
        if ($coupon->isDisabled()) {
        if ($coupon->/** @scrutinizer ignore-call */ isDisabled()) {
            event(new CouponDisabled($coupon, $redeemer));

            throw new CouponDisabledException;
        }

        if ($coupon->isExpired()) {
        if ($coupon->/** @scrutinizer ignore-call */ isExpired()) {
            event(new CouponExpired($coupon, $redeemer));

            throw new CouponExpiredException;
        }

        if ($coupon->isOverQuantity()) {
        if ($coupon->/** @scrutinizer ignore-call */ isOverQuantity()) {
            event(new CouponIsOverQuantity($coupon, $redeemer));

            throw new OverQuantityException;
        }

        return $coupon;
    }

    /**
     * Perform the "Redeemer" checks on the coupon model.
     *
     * @param  CouponContract  $coupon
     * @param  Model  $redeemer
     *
     * @return CouponContract
     *
     * @throws OverLimitException
     * @throws NotAllowedToRedeemException
     */
    public function performChecksOnRedeemer(CouponContract $coupon, Model $redeemer): CouponContract
    {
        if (! $coupon->isAllowedToRedeemBy($redeemer)) {
        if (! $coupon->/** @scrutinizer ignore-call */ isAllowedToRedeemBy($redeemer)) {
            event(new NotAllowedToRedeem($coupon, $redeemer));

            throw new NotAllowedToRedeemException;
        }

        if ($coupon->isOverLimit($redeemer)) {
        if ($coupon->/** @scrutinizer ignore-call */ isOverLimit($redeemer)) {
            event(new CouponIsOverLimit($coupon, $redeemer));

            throw new OverLimitException;
        }

        return $coupon;
    }

    /**
     * Verify if coupon is valid otherwise throw an exception.
     *
     * @param  string|null  $code
     * @param  Model|null  $redeemer
     *
     * @return CouponContract
     * @throws CouponExpiredException
     * @throws InvalidCouponException
     * @throws NotAllowedToRedeemException
     * @throws OverLimitException
     * @throws OverQuantityException
     * @throws CouponDisabledException
     */
    public function verifyCoupon(?string $code, ?Model $redeemer = null): CouponContract
    {
        $coupon = $this->getCoupon($code) ?? throw new InvalidCouponException;

        $this->performBasicChecks($coupon);

        if ($redeemer) {
            $this->performChecksOnRedeemer($coupon, $redeemer);
        }

        event(new CouponVerified($coupon, $redeemer));

        return $coupon;
    }

    /**
     * Apply the coupon.
     *
     * @param  CouponContract  $coupon
     * @param  Model  $redeemer
     * @param  Model|null  $redeemed
     *
     * @return CouponContract
     */
    public function applyCoupon(CouponContract $coupon, Model $redeemer, ?Model $redeemed): CouponContract
    {
        $redeemer->coupons()->attach($coupon, [
            $this->pivot->getRedeemedTypeColumn() => $redeemed?->getMorphClass(),
            $this->pivot->getRedeemedIdColumn()   => $redeemed?->id,
            $this->pivot->getRedeemedAtColumn()   => now(),
            $this->pivot->getCreatedAtColumn()    => now(),
        ]);

        if (! is_null($coupon->{$this->model->getQuantityColumn()})) {
            $coupon->decrement($this->model->getQuantityColumn());
                     decrement($this->model->getQuantityColumn());
        }

        event(new CouponRedeemed($coupon, $redeemer));

        return $coupon;
    }
}


michael-rubel / laravel-couponables

Pull Request — main (#26)

CouponService::performChecksOnRedeemer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like