Vouchers::isValidCode() - Code Metrics - Inspection of "Enhancement: Add Function to Check Voucher Validit..." - beyondcode/laravel-vouchers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#51)

unknown

created 2023-12-15 14:12 UTC

Vouchers::isValidCode() A

↳ Parent: Vouchers

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	11
rs	10

<?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));
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * 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

     * @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);

    }

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

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

        return $voucher;
    }
}


1			<?php
2
3			namespace BeyondCode\Vouchers;
4
5			use BeyondCode\Vouchers\Exceptions\VoucherExpired;
6			use BeyondCode\Vouchers\Exceptions\VoucherIsInvalid;
7			use BeyondCode\Vouchers\Models\Voucher;
8			use Illuminate\Database\Eloquent\Model;
9
10			class Vouchers
11			{
12			/** @var VoucherGenerator */
13			private $generator;
14			/** @var \BeyondCode\Vouchers\Models\Voucher */
15			private $voucherModel;
16
17			public function __construct(VoucherGenerator $generator)
18			{
19			$this->generator = $generator;
20			$this->voucherModel = app(config('vouchers.model', Voucher::class));
			0 ignored issues – show Documentation Bug introduced 2023-12-15 14:24 UTC by Report Bug Copy Issue Report It seems like `app(config('vouchers.mod...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? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
21			}
22
23			/**
24			* Generate the specified amount of codes and return
25			* an array with all the generated codes.
26			*
27			* @param int $amount
28			* @return array
29			*/
30			public function generate(int $amount = 1): array
31			{
32			$codes = [];
33
34			for ($i = 1; $i <= $amount; $i++) {
35			$codes[] = $this->getUniqueVoucher();
36			}
37
38			return $codes;
39			}
40
41			/**
42			* @param Model $model
43			* @param int $amount
44			* @param array $data
45			* @param null $expires_at
			0 ignored issues – show Documentation Bug introduced 2023-12-15 14:24 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$expires_at` is correct as it would always require `null` to be passed? Loading history...
46			* @return array
47			*/
48			public function create(Model $model, int $amount = 1, array $data = [], $expires_at = null)
49			{
50			$vouchers = [];
51
52			foreach ($this->generate($amount) as $voucherCode) {
53			$vouchers[] = $this->voucherModel->create([
54			'model_id' => $model->getKey(),
55			'model_type' => $model->getMorphClass(),
56			'code' => $voucherCode,
57			'data' => $data,
58			'expires_at' => $expires_at,
59			]);
60			}
61
62			return $vouchers;
63			}
64
65			/**
66			* @param string $code
67			* @throws VoucherIsInvalid
68			* @throws VoucherExpired
69			* @return Voucher
70			*/
71			public function check(string $code)
72			{
73			$voucher = $this->voucherModel->whereCode($code)->first();
74
75			if (is_null($voucher)) {
76			throw VoucherIsInvalid::withCode($code);
77			}
78			if ($voucher->isExpired()) {
79			throw VoucherExpired::create($voucher);
80			}
81
82			return $voucher;
83			}
84
85			/**
86			* @param string $code
87			* @return bool
88			*/
89			public function isValidCode(string $code): bool
90			{
91			try {
92			$this->check($code);
93			} catch (VoucherIsInvalid $exception) {
94			return false;
95			} catch (VoucherExpired $exception) {
96			return false;
97			}
98
99			return true;
100			}
101
102			/**
103			* @param Voucher $voucher
104			* @return bool
105			*/
106			public function isValidVoucher(Voucher $voucher): bool
107			{
108			return $this->isValidCode($voucher->code);
			0 ignored issues – show Bug introduced 2023-12-15 14:24 UTC by Report Bug Copy Issue Report The property `code` does not seem to exist on `BeyondCode\Vouchers\Models\Voucher`. Are you sure there is no database migration missing? Checks if undeclared accessed properties appear in database migrations and if the creating migration is correct. Loading history...
109			}
110
111			/**
112			* @return string
113			*/
114			protected function getUniqueVoucher(): string
115			{
116			$voucher = $this->generator->generateUnique();
117
118			while ($this->voucherModel->whereCode($voucher)->count() > 0) {
119			$voucher = $this->generator->generateUnique();
120			}
121
122			return $voucher;
123			}
124			}
125

beyondcode / laravel-vouchers

Pull Request — master (#51)

Vouchers::isValidCode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like