Leasing::modifyCharge() - Code Metrics - Inspection of "implemented basic Leasing" - hiqdev/php-billing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9a2061...9f070b )

by Andrii

created 2018-05-23 08:16 UTC

Leasing::modifyCharge() B

↳ Parent: Leasing

Complexity

Conditions	5
Paths	6

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5.5069

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	8
cts	11
cp	0.7272
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	11
nc	6
nop	2
crap	5.5069

<?php
/**
 * PHP Billing Library
 *
 * @link      https://github.com/hiqdev/php-billing
 * @package   php-billing
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2017-2018, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\php\billing\charge\modifiers;

use DateTimeImmutable;
use hiqdev\php\billing\action\ActionInterface;
use hiqdev\php\billing\charge\ChargeInterface;
use hiqdev\php\billing\charge\modifiers\addons\Period;
use hiqdev\php\billing\price\SinglePrice;
use hiqdev\php\billing\target\Target;
use hiqdev\php\billing\type\Type;
use hiqdev\php\units\Quantity;
use Money\Money;

/**
 * Leasing.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Leasing extends Modifier
{
    const TERM = 'term';

    public function lasts($term): self
    {
        return $this->addAddon(self::TERM, Period::fromString($term));
    }

    public function getTerm(): ?Period
    {
        return $this->getAddon(self::TERM);
    }

    public function isAbsolute()
    {
        return $this->getAddon(self::VALUE)->isAbsolute();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function isRelative()
    {
        return !$this->isAbsolute();
    }

    public function calculateSum(ChargeInterface $charge = null): Money
    {
        return $this->getValue($charge)->calculateSum($charge);

    }

    public function buildPrice(Money $sum)
    {
        $type = $this->getType();
        $target = $this->getTarget();
        $prepaid = Quantity::items(0);

        return new SinglePrice(null, $type, $target, null, $prepaid, $sum);
    }

    public function getType()
    {
        return new Type(Type::ANY, 'discount');
    }

    public function getTarget()
    {
        return new Target(Target::ANY, Target::ANY);
    }

    public function till($dummy)
    {
        throw new \Exception('till can not be defined for leasing');
    }

    public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
    {
        if ($charge === null) {
            $charge = $this->calculateCharge($charge, $action);

        }

        $month = $action->getTime()->modify('first day of this month midnight');
        $num = $this->countPeriodsPassed($month);
        if ($num >= 1 || !$this->checkPeriod($month)) {
            return [];
        }

        $reason = $this->getReason();
        if ($reason) {
            $charge->setComment($reason->getValue());
        }

        return [$charge];
    }

    protected function countPeriodsPassed(DateTimeImmutable $time)
    {
        $since = $this->getSince();
        if ($since === null) {
            throw new \Exception('no since given for leasing');
        }

        $term = $this->getTerm();
        if ($term === null) {
            throw new \Exception('no term given for leasing');
        }

        return $term->countPeriodsPassed($since->getValue(), $time);
    }
}


1		<?php
2		/**
3		* PHP Billing Library
4		*
5		* @link https://github.com/hiqdev/php-billing
6		* @package php-billing
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2017-2018, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\php\billing\charge\modifiers;
12
13		use DateTimeImmutable;
14		use hiqdev\php\billing\action\ActionInterface;
15		use hiqdev\php\billing\charge\ChargeInterface;
16		use hiqdev\php\billing\charge\modifiers\addons\Period;
17		use hiqdev\php\billing\price\SinglePrice;
18		use hiqdev\php\billing\target\Target;
19		use hiqdev\php\billing\type\Type;
20		use hiqdev\php\units\Quantity;
21		use Money\Money;
22
23		/**
24		* Leasing.
25		*
26		* @author Andrii Vasyliev <[email protected]>
27		*/
28		class Leasing extends Modifier
29		{
30		const TERM = 'term';
31
32	5	public function lasts($term): self
33		{
34	5	return $this->addAddon(self::TERM, Period::fromString($term));
35		}
36
37	3	public function getTerm(): ?Period
38		{
39	3	return $this->getAddon(self::TERM);
40		}
41
42		public function isAbsolute()
43		{
44		return $this->getAddon(self::VALUE)->isAbsolute();
		0 ignored issues – show Bug introduced 2018-05-23 08:23 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\php\billing\charge\modifiers\AddonInterface` as the method `isAbsolute()` does only exist in the following implementations of said interface: `hiqdev\php\billing\charg...difiers\addons\Discount`, `hiqdev\php\billing\charg...difiers\addons\Extremum`, `hiqdev\php\billing\charge\modifiers\addons\Maximum`, `hiqdev\php\billing\charge\modifiers\addons\Minimum`, `hiqdev\php\billing\charge\modifiers\addons\Step`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45		}
46
47		public function isRelative()
48		{
49		return !$this->isAbsolute();
50		}
51
52		public function calculateSum(ChargeInterface $charge = null): Money
53		{
54		return $this->getValue($charge)->calculateSum($charge);
		0 ignored issues – show Bug introduced 2018-05-23 08:23 UTC by Report Bug Copy Issue Report The method `getValue()` does not seem to exist on `object<hiqdev\php\billin...arge\modifiers\Leasing>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
55		}
56
57		public function buildPrice(Money $sum)
58		{
59		$type = $this->getType();
60		$target = $this->getTarget();
61		$prepaid = Quantity::items(0);
62
63		return new SinglePrice(null, $type, $target, null, $prepaid, $sum);
64		}
65
66		public function getType()
67		{
68		return new Type(Type::ANY, 'discount');
69		}
70
71		public function getTarget()
72		{
73		return new Target(Target::ANY, Target::ANY);
74		}
75
76	1	public function till($dummy)
77		{
78	1	throw new \Exception('till can not be defined for leasing');
79		}
80
81	1	public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
82		{
83	1	if ($charge === null) {
84		$charge = $this->calculateCharge($charge, $action);
		0 ignored issues – show Bug introduced 2018-05-23 08:23 UTC by Report Bug Copy Issue Report The method `calculateCharge()` does not seem to exist on `object<hiqdev\php\billin...arge\modifiers\Leasing>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
85		}
86
87	1	$month = $action->getTime()->modify('first day of this month midnight');
88	1	$num = $this->countPeriodsPassed($month);
89	1	if ($num >= 1 \|\| !$this->checkPeriod($month)) {
90		return [];
91		}
92
93	1	$reason = $this->getReason();
94	1	if ($reason) {
95		$charge->setComment($reason->getValue());
96		}
97
98	1	return [$charge];
99		}
100
101	1	protected function countPeriodsPassed(DateTimeImmutable $time)
102		{
103	1	$since = $this->getSince();
104	1	if ($since === null) {
105		throw new \Exception('no since given for leasing');
106		}
107
108	1	$term = $this->getTerm();
109	1	if ($term === null) {
110		throw new \Exception('no term given for leasing');
111		}
112
113	1	return $term->countPeriodsPassed($since->getValue(), $time);
114		}
115		}
116

hiqdev / php-billing

Push — master ( 9a2061...9f070b )

Leasing::modifyCharge() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like