BeyondCode\Vouchers\Vouchers

Complexity

Total Complexity

14

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isValidVoucher()	0	3	1
A	check()	0	12	3
A	isValidCode()	0	11	3
A	getUniqueVoucher()	0	9	2
A	create()	0	15	2
A	generate()	0	9	2

<?php

namespace BeyondCode\Vouchers;

use BeyondCode\Vouchers\Exceptions\VoucherExpired;
use BeyondCode\Vouchers\Exceptions\VoucherIsInvalid;
use BeyondCode\Vouchers\Models\Voucher;
use Illuminate\Database\Eloquent\Model;

class Vouchers
{
    /** @var VoucherGenerator */
    private $generator;
    /** @var \BeyondCode\Vouchers\Models\Voucher  */
    private $voucherModel;

    public function __construct(VoucherGenerator $generator)
    {
        $this->generator = $generator;
        $this->voucherModel = app(config('vouchers.model', Voucher::class));

It seems like app(config('vouchers.model', BeyondCode\Vouchers\Models\Voucher::class)) can also be of type Illuminate\Contracts\Foundation\Application. However, the property $voucherModel is declared as type BeyondCode\Vouchers\Models\Voucher. Maybe add an additional type check?

    }

    /**
     * Generate the specified amount of codes and return
     * an array with all the generated codes.
     *
     * @param int $amount
     * @return array
     */
    public function generate(int $amount = 1): array
    {
        $codes = [];

        for ($i = 1; $i <= $amount; $i++) {
            $codes[] = $this->getUniqueVoucher();
        }

        return $codes;
    }

    /**
     * @param Model $model
     * @param int $amount
     * @param array $data
     * @param null $expires_at

Are you sure the doc-type for parameter $expires_at is correct as it would always require null to be passed?

     * @return array
     */
    public function create(Model $model, int $amount = 1, array $data = [], $expires_at = null)
    {
        $vouchers = [];

        foreach ($this->generate($amount) as $voucherCode) {
            $vouchers[] = $this->voucherModel->create([
                'model_id' => $model->getKey(),
                'model_type' => $model->getMorphClass(),
                'code' => $voucherCode,
                'data' => $data,
                'expires_at' => $expires_at,
            ]);
        }

        return $vouchers;
    }

    /**
     * @param string $code
     * @throws VoucherIsInvalid
     * @throws VoucherExpired
     * @return Voucher
     */
    public function check(string $code)
    {
        $voucher = $this->voucherModel->whereCode($code)->first();

        if (is_null($voucher)) {
            throw VoucherIsInvalid::withCode($code);
        }
        if ($voucher->isExpired()) {
            throw VoucherExpired::create($voucher);
        }

        return $voucher;
    }

    /**
     * @param string $code
     * @return bool
     */
    public function isValidCode(string $code): bool
    {
        try {
            $this->check($code);
        } catch (VoucherIsInvalid $exception) {
            return false;
        } catch (VoucherExpired $exception) {
            return false;
        }

        return true;
    }

    /**
     * @param Voucher $voucher
     * @return bool
     */
    public function isValidVoucher(Voucher $voucher): bool
    {
        return $this->isValidCode($voucher->code);

The property code does not seem to exist on BeyondCode\Vouchers\Models\Voucher. Are you sure there is no database migration missing?

    }

    /**
     * @return string
     */
    protected function getUniqueVoucher(): string
    {
        $voucher = $this->generator->generateUnique();

        while ($this->voucherModel->whereCode($voucher)->count() > 0) {
            $voucher = $this->generator->generateUnique();
        }

        return $voucher;
    }
}