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

Completed

Push — master ( 6dde3c...c34bb5 )

by Andrii

created 2018-06-06 13:58 UTC

Leasing::isRelative() A

↳ Parent: Leasing

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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 hiqdev\php\billing\action\ActionInterface;
use hiqdev\php\billing\charge\ChargeInterface;
use hiqdev\php\billing\formula\FormulaSemanticsError;
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
{
    public function getNext()
    {
        return $this;
    }

    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 FormulaSemanticsError('till can not be defined for leasing');
    }

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

        }

        $this->ensureIsValid();

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

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

        return [$charge];
    }

    protected function ensureIsValid()
    {
        $since = $this->getSince();
        if ($since === null) {
            throw new FormulaSemanticsError('no since given for leasing');
        }

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


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 hiqdev\php\billing\action\ActionInterface;
14		use hiqdev\php\billing\charge\ChargeInterface;
15		use hiqdev\php\billing\formula\FormulaSemanticsError;
16		use hiqdev\php\billing\price\SinglePrice;
17		use hiqdev\php\billing\target\Target;
18		use hiqdev\php\billing\type\Type;
19		use hiqdev\php\units\Quantity;
20		use Money\Money;
21
22		/**
23		* Leasing.
24		*
25		* @author Andrii Vasyliev <[email protected]>
26		*/
27		class Leasing extends Modifier
28		{
29	6	public function getNext()
30		{
31	6	return $this;
32		}
33
34		public function isAbsolute()
35		{
36		return $this->getAddon(self::VALUE)->isAbsolute();
		0 ignored issues – show Bug introduced 2018-05-18 16:35 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...
37		}
38
39		public function isRelative()
40		{
41		return !$this->isAbsolute();
42		}
43
44		public function calculateSum(ChargeInterface $charge = null): Money
45		{
46		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...
47		}
48
49		public function buildPrice(Money $sum)
50		{
51		$type = $this->getType();
52		$target = $this->getTarget();
53		$prepaid = Quantity::items(0);
54
55		return new SinglePrice(null, $type, $target, null, $prepaid, $sum);
56		}
57
58		public function getType()
59		{
60		return new Type(Type::ANY, 'discount');
61		}
62
63		public function getTarget()
64		{
65		return new Target(Target::ANY, Target::ANY);
66		}
67
68	1	public function till($dummy)
69		{
70	1	throw new FormulaSemanticsError('till can not be defined for leasing');
71		}
72
73	1	public function modifyCharge(?ChargeInterface $charge, ActionInterface $action): array
74		{
75	1	if ($charge === null) {
76		$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...
77		}
78
79	1	$this->ensureIsValid();
80
81	1	$month = $action->getTime()->modify('first day of this month midnight');
82	1	if (!$this->checkPeriod($month)) {
83		return [];
84		}
85
86	1	$reason = $this->getReason();
87	1	if ($reason) {
88		$charge->setComment($reason->getValue());
89		}
90
91	1	return [$charge];
92		}
93
94	1	protected function ensureIsValid()
95		{
96	1	$since = $this->getSince();
97	1	if ($since === null) {
98		throw new FormulaSemanticsError('no since given for leasing');
99		}
100
101	1	$term = $this->getTerm();
102	1	if ($term === null) {
103		throw new FormulaSemanticsError('no term given for leasing');
104		}
105	1	}
106		}
107

hiqdev / php-billing

Push — master ( 6dde3c...c34bb5 )

Leasing::isRelative() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like