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

Completed

Push — master ( 7d972a...3baf5c )

by Andrii

created 2018-05-18 16:33 UTC

GrowingDiscount::getPeriod() A

↳ Parent: GrowingDiscount

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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\charge\ChargeInterface;
use hiqdev\php\billing\charge\modifiers\addons\Maximum;
use hiqdev\php\billing\charge\modifiers\addons\Minimum;
use hiqdev\php\billing\charge\modifiers\addons\MonthPeriod;
use hiqdev\php\billing\charge\modifiers\addons\Step;
use hiqdev\php\billing\charge\modifiers\addons\YearPeriod;
use Money\Money;

/**
 * Growing discount.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class GrowingDiscount extends FixedDiscount
{
    const PERIOD = 'period';
    const STEP = 'step';
    const MIN = 'min';
    const MAX = 'max';

    public function __construct($step, $min = null, array $addons = [])
    {
        Modifier::__construct($addons);
        $this->addAddon(self::STEP, new Step($step));
        if ($min) {
            $this->min($min);
        }
    }

    public function isAbsolute()
    {
        return $this->getStep()->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 getStep()
    {
        return $this->getAddon(self::STEP);
    }

    public function getMin()
    {
        return $this->getAddon(self::MIN);
    }

    public function getMax()
    {
        return $this->getAddon(self::MAX);
    }

    public function min($min)
    {
        return $this->addExtremum(self::MIN, new Minimum($min));
    }

    public function max($max)
    {
        return $this->addExtremum(self::MAX, new Maximum($max));
    }

    protected function addExtremum($name, AddonInterface $addon)
    {
        $value = $addon->getValue();
        if ($value instanceof Money) {
            if ($this->isRelative()) {
                throw new \Exception("'$name' must be given as percentage because step is percentage");
            }
        } elseif ($this->isAbsolute()) {
            throw new \Exception("'$name' must be money because step is money");
        }

        return $this->addAddon($name, $addon);
    }

    public function getPeriod()
    {
        return $this->getAddon(self::PERIOD);
    }

    public function everyMonth($num = 1)
    {
        return $this->addAddon(self::PERIOD, new MonthPeriod($num));
    }

    public function everyYear($num = 1)
    {
        return $this->addAddon(self::PERIOD, new YearPeriod($num));
    }

    public function getValue(ChargeInterface $charge = null)
    {
        $time = $charge ? $charge->getAction()->getTime() : new DateTimeImmutable();
        $num = $this->countPeriodsPassed($time);

        return $this->getStep()->calculateFor($num, $this->getMin(), $this->getMax());
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.
    }
}
    }

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

        $period = $this->getPeriod();
        if ($period === null) {
            throw new \Exception('no period given for growing discount');
        }

        return $period->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\charge\ChargeInterface;
15		use hiqdev\php\billing\charge\modifiers\addons\Maximum;
16		use hiqdev\php\billing\charge\modifiers\addons\Minimum;
17		use hiqdev\php\billing\charge\modifiers\addons\MonthPeriod;
18		use hiqdev\php\billing\charge\modifiers\addons\Step;
19		use hiqdev\php\billing\charge\modifiers\addons\YearPeriod;
20		use Money\Money;
21
22		/**
23		* Growing discount.
24		*
25		* @author Andrii Vasyliev <[email protected]>
26		*/
27		class GrowingDiscount extends FixedDiscount
28		{
29		const PERIOD = 'period';
30		const STEP = 'step';
31		const MIN = 'min';
32		const MAX = 'max';
33
34	5	public function __construct($step, $min = null, array $addons = [])
35		{
36	5	Modifier::__construct($addons);
37	5	$this->addAddon(self::STEP, new Step($step));
38	5	if ($min) {
39		$this->min($min);
40		}
41	5	}
42
43	4	public function isAbsolute()
44		{
45	4	return $this->getStep()->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...
46		}
47
48	4	public function getStep()
49		{
50	4	return $this->getAddon(self::STEP);
51		}
52
53	4	public function getMin()
54		{
55	4	return $this->getAddon(self::MIN);
56		}
57
58	4	public function getMax()
59		{
60	4	return $this->getAddon(self::MAX);
61		}
62
63		public function min($min)
64		{
65		return $this->addExtremum(self::MIN, new Minimum($min));
66		}
67
68		public function max($max)
69		{
70		return $this->addExtremum(self::MAX, new Maximum($max));
71		}
72
73		protected function addExtremum($name, AddonInterface $addon)
74		{
75		$value = $addon->getValue();
76		if ($value instanceof Money) {
77		if ($this->isRelative()) {
78		throw new \Exception("'$name' must be given as percentage because step is percentage");
79		}
80		} elseif ($this->isAbsolute()) {
81		throw new \Exception("'$name' must be money because step is money");
82		}
83
84		return $this->addAddon($name, $addon);
85		}
86
87	4	public function getPeriod()
88		{
89	4	return $this->getAddon(self::PERIOD);
90		}
91
92	4	public function everyMonth($num = 1)
93		{
94	4	return $this->addAddon(self::PERIOD, new MonthPeriod($num));
95		}
96
97		public function everyYear($num = 1)
98		{
99		return $this->addAddon(self::PERIOD, new YearPeriod($num));
100		}
101
102	4	public function getValue(ChargeInterface $charge = null)
103		{
104	4	$time = $charge ? $charge->getAction()->getTime() : new DateTimeImmutable();
105	4	$num = $this->countPeriodsPassed($time);
106
107	4	return $this->getStep()->calculateFor($num, $this->getMin(), $this->getMax());
		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 `calculateFor()` does only exist in the following implementations of said interface: `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...
108		}
109
110	4	protected function countPeriodsPassed(DateTimeImmutable $time)
111		{
112	4	$since = $this->getSince();
113	4	if ($since === null) {
114		throw new \Exception('no since given for growing discount');
115		}
116
117	4	$period = $this->getPeriod();
118	4	if ($period === null) {
119		throw new \Exception('no period given for growing discount');
120		}
121
122	4	return $period->countPeriodsPassed($since->getValue(), $time);
123		}
124		}
125

hiqdev / php-billing

Push — master ( 7d972a...3baf5c )

GrowingDiscount::getPeriod() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like