Package - Code Metrics - Inspection of "Moving from Package god-object to decorators in fi..." - hiqdev/hipanel-module-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 81b279...95954c )

by Dmitry

created 2016-09-02 14:20 UTC

Package B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	243
Duplicated Lines	11.93 %

Coupling/Cohesion

Components	3
Dependencies	4

Test Coverage

Coverage

Importance

Changes	6
Bugs	0	Features	2

Metric	Value
wmc	36
c	6
b	0
f	2
lcom	3
cbo	4
dl	29
loc	243
ccs	0
cts	134
cp	0
rs	8.8

20 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	10	4
A	setTariff()	0	4	1
A	initResources()	0	11	2
A	buildResourceClass()	0	8	2
A	getTariff()	0	4	1
A	getResourceValue_panel()	0	9	2
A	getResourceTitle_panel()	0	4	1
A	getResourceValue_purpose()	0	4	1
A	getResourceTitle_purpose()	0	4	1
A	getPrice()	0	4	1
A	getDisplayPrice()	0	6	1
A	getName()	0	4	1
A	getResourceValue()	10	10	2
A	getResourceTitle()	9	9	2
A	getOverusePrice()	9	9	2
A	getPartByType()	0	10	3
A	getResourceByType()	0	10	3
A	getResourceByModelType()	0	10	3
A	getLocations()	0	6	1
A	getId()	0	8	2

How to fix Duplicated Code

<?php

/*
 * Server module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-server
 * @package   hipanel-module-server
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\models;

use hipanel\modules\server\cart\Tariff;
use hipanel\modules\stock\models\Part;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;

/**
 * Class Package is a wrapper for [[Tariff]], its parts, resources and calculation of its price.
 * @property string $name
 */
class Package extends Model
{
    /**
     * @var string CRC32 temporary uniq id of the package
     */
    private $_id;

    /** @var Tariff */
    protected $_tariff;

    /** @var Part[] */
    public $parts = [];

    /** @var array */
    public $calculation;

    /**
     * @var
     */
    protected $_resources;

    public function init()
    {
        if (empty($this->parts)) {
            foreach ($this->getTariff()->resources as $resource) {
                if (isset($resource->part)) {
                    $this->parts[$resource->part->id] = $resource->part;
                }
            }
        }
    }

    /**
     * @param Tariff $tariff
     */
    public function setTariff($tariff)
    {
        $this->_tariff = $tariff;
    }

    /**
     * @throws InvalidConfigException
     * TODO: implement and get rid of many magic functions bellow
     */
    protected function initResources()
    {
        foreach ($this->_tariff->resources as $resource) {
            $id = $resource->id;

            $this->_resources[$id] = Yii::createObject([
                'class' => $this->buildResourceClass($resource),
                'resource' => $resource,
            ]);
        }
    }

    /**
     * @param $resource
     * @return string
     * TODO: implement and get rid of many magic functions bellow
     */
    protected function buildResourceClass($resource)
    {
        if ($this->parts[$resource->object_id]) {
            return 'yii\base\Object';
        } else {
            return 'yii\base\Object';
        }
    }

    /**
     * @return Tariff
     */
    public function getTariff()
    {
        return $this->_tariff;
    }

    protected function getResourceValue_panel()
    {
        $result = Yii::t('hipanel/server/order', 'No panel / {hipanelLink}', ['hipanelLink' => 'HiPanel']); // todo: add faq link
        if ($this->getResourceByType('isp5')->quantity > 0) {
            $result .= ' / ' . Yii::t('hipanel/server/order', 'ISP manager');
        }

        return $result;
    }

    protected function getResourceTitle_panel()
    {
        return Yii::t('hipanel/server/order', 'Control panel');
    }

    protected function getResourceValue_purpose()
    {
        return Yii::t('hipanel/server/order/purpose', $this->_tariff->label);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    protected function getResourceTitle_purpose()
    {
        return Yii::t('hipanel/server/order', 'Purpose');
    }

    /**
     * @return float
     */
    public function getPrice()
    {
        return $this->calculation['value']['usd']['value'];
    }

    /**
     * @throws InvalidConfigException
     * @return string
     */
    public function getDisplayPrice()
    {
        return Yii::t('hipanel/server/order', '{price}/mo', [
            'price' => Yii::$app->formatter->asCurrency($this->getPrice(), Yii::$app->params['currency']),
        ]);
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->_tariff->name;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @param string $type
     * @throws InvalidConfigException
     * @return mixed
     */
    public function getResourceValue($type)

    {
        $method = 'getResourceValue_' . $type;

        if (method_exists($this, $method)) {
            return call_user_func([$this, $method]);
        }

        throw new InvalidConfigException("Resource type \"$type\" is not described in the Package");
    }

    /**
     * @param string $type
     * @throws InvalidConfigException
     * @return string
     */
    public function getResourceTitle($type)

    {
        $method = 'getResourceTitle_' . $type;
        if (method_exists($this, $method)) {
            return call_user_func([$this, $method]);
        }

        throw new InvalidConfigException("Resource type \"$type\" is not described in the Package");
    }

    /**
     * @param $type
     * @throws InvalidConfigException
     * @return array|null
     */
    public function getOverusePrice($type)

    {
        $method = 'getResourceOveruse_' . $type;
        if (method_exists($this, $method)) {
            return call_user_func([$this, $method]);
        }

        throw new InvalidConfigException("Overuse getter for resource type \"$type\" is not described in the Package");
    }

    /**
     * @param string $type
     * @return Part|null
     */
    public function getPartByType($type)
    {
        foreach ($this->parts as $part) {
            if ($part->model_type === $type) {
                return $part;
            }
        }

        return null;
    }

    /**
     * @param string $type
     * @return Resource|null
     */
    public function getResourceByType($type)
    {
        foreach ($this->_tariff->resources as $resource) {
            if ($resource->type === $type) {
                return $resource;
            }
        }

        return null;
    }

    /**
     * @param string $type
     * @return resource|null
     */
    public function getResourceByModelType($type)
    {
        foreach ($this->_tariff->resources as $resource) {
            if ($resource->model_type === $type) {
                return $resource;
            }
        }

        return null;
    }

    /**
     * @return array
     */
    public function getLocations()
    {
        return [
            1 => Yii::t('hipanel/server/order', 'Netherlands, Amsterdam'),
        ];
    }

    /**
     * @return string
     */
    public function getId()
    {
        if (!isset($this->_id)) {
            $this->_id = hash('crc32b', implode('_', ['server', 'order', uniqid()]));
        }

        return $this->_id;
    }
}


1		<?php
2
3		/*
4		* Server module for HiPanel
5		*
6		* @link https://github.com/hiqdev/hipanel-module-server
7		* @package hipanel-module-server
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hipanel\modules\server\models;
13
14		use hipanel\modules\server\cart\Tariff;
15		use hipanel\modules\stock\models\Part;
16		use Yii;
17		use yii\base\InvalidConfigException;
18		use yii\base\Model;
19
20		/**
21		* Class Package is a wrapper for [[Tariff]], its parts, resources and calculation of its price.
22		* @property string $name
23		*/
24		class Package extends Model
25		{
26		/**
27		* @var string CRC32 temporary uniq id of the package
28		*/
29		private $_id;
30
31		/** @var Tariff */
32		protected $_tariff;
33
34		/** @var Part[] */
35		public $parts = [];
36
37		/** @var array */
38		public $calculation;
39
40		/**
41		* @var
42		*/
43		protected $_resources;
44
45		public function init()
46		{
47		if (empty($this->parts)) {
48		foreach ($this->getTariff()->resources as $resource) {
49		if (isset($resource->part)) {
50		$this->parts[$resource->part->id] = $resource->part;
51		}
52		}
53		}
54		}
55
56		/**
57		* @param Tariff $tariff
58		*/
59		public function setTariff($tariff)
60		{
61		$this->_tariff = $tariff;
62		}
63
64		/**
65		* @throws InvalidConfigException
66		* TODO: implement and get rid of many magic functions bellow
67		*/
68		protected function initResources()
69		{
70		foreach ($this->_tariff->resources as $resource) {
71		$id = $resource->id;
72
73		$this->_resources[$id] = Yii::createObject([
74		'class' => $this->buildResourceClass($resource),
75		'resource' => $resource,
76		]);
77		}
78		}
79
80		/**
81		* @param $resource
82		* @return string
83		* TODO: implement and get rid of many magic functions bellow
84		*/
85		protected function buildResourceClass($resource)
86		{
87		if ($this->parts[$resource->object_id]) {
88		return 'yii\base\Object';
89		} else {
90		return 'yii\base\Object';
91		}
92		}
93
94		/**
95		* @return Tariff
96		*/
97		public function getTariff()
98		{
99		return $this->_tariff;
100		}
101
102		protected function getResourceValue_panel()
103		{
104		$result = Yii::t('hipanel/server/order', 'No panel / {hipanelLink}', ['hipanelLink' => 'HiPanel']); // todo: add faq link
105		if ($this->getResourceByType('isp5')->quantity > 0) {
106		$result .= ' / ' . Yii::t('hipanel/server/order', 'ISP manager');
107		}
108
109		return $result;
110		}
111
112		protected function getResourceTitle_panel()
113		{
114		return Yii::t('hipanel/server/order', 'Control panel');
115		}
116
117		protected function getResourceValue_purpose()
118		{
119		return Yii::t('hipanel/server/order/purpose', $this->_tariff->label);
		0 ignored issues – show Documentation introduced 2016-05-23 17:30 UTC by Report Bug Copy Issue Report The property `label` does not exist on `object<hipanel\modules\server\cart\Tariff>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
120		}
121
122		protected function getResourceTitle_purpose()
123		{
124		return Yii::t('hipanel/server/order', 'Purpose');
125		}
126
127		/**
128		* @return float
129		*/
130		public function getPrice()
131		{
132		return $this->calculation['value']['usd']['value'];
133		}
134
135		/**
136		* @throws InvalidConfigException
137		* @return string
138		*/
139		public function getDisplayPrice()
140		{
141		return Yii::t('hipanel/server/order', '{price}/mo', [
142		'price' => Yii::$app->formatter->asCurrency($this->getPrice(), Yii::$app->params['currency']),
143		]);
144		}
145
146		/**
147		* @return string
148		*/
149		public function getName()
150		{
151		return $this->_tariff->name;
		0 ignored issues – show Documentation introduced 2016-04-28 16:16 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<hipanel\modules\server\cart\Tariff>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
152		}
153
154		/**
155		* @param string $type
156		* @throws InvalidConfigException
157		* @return mixed
158		*/
159	View Code Duplication	public function getResourceValue($type)
		0 ignored issues – show Duplication introduced 2016-04-14 17:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
160		{
161		$method = 'getResourceValue_' . $type;
162
163		if (method_exists($this, $method)) {
164		return call_user_func([$this, $method]);
165		}
166
167		throw new InvalidConfigException("Resource type \"$type\" is not described in the Package");
168		}
169
170		/**
171		* @param string $type
172		* @throws InvalidConfigException
173		* @return string
174		*/
175	View Code Duplication	public function getResourceTitle($type)
		0 ignored issues – show Duplication introduced 2016-04-14 17:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
176		{
177		$method = 'getResourceTitle_' . $type;
178		if (method_exists($this, $method)) {
179		return call_user_func([$this, $method]);
180		}
181
182		throw new InvalidConfigException("Resource type \"$type\" is not described in the Package");
183		}
184
185		/**
186		* @param $type
187		* @throws InvalidConfigException
188		* @return array\|null
189		*/
190	View Code Duplication	public function getOverusePrice($type)
		0 ignored issues – show Duplication introduced 2016-04-14 17:15 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
191		{
192		$method = 'getResourceOveruse_' . $type;
193		if (method_exists($this, $method)) {
194		return call_user_func([$this, $method]);
195		}
196
197		throw new InvalidConfigException("Overuse getter for resource type \"$type\" is not described in the Package");
198		}
199
200		/**
201		* @param string $type
202		* @return Part\|null
203		*/
204		public function getPartByType($type)
205		{
206		foreach ($this->parts as $part) {
207		if ($part->model_type === $type) {
208		return $part;
209		}
210		}
211
212		return null;
213		}
214
215		/**
216		* @param string $type
217		* @return Resource\|null
218		*/
219		public function getResourceByType($type)
220		{
221		foreach ($this->_tariff->resources as $resource) {
222		if ($resource->type === $type) {
223		return $resource;
224		}
225		}
226
227		return null;
228		}
229
230		/**
231		* @param string $type
232		* @return resource\|null
233		*/
234		public function getResourceByModelType($type)
235		{
236		foreach ($this->_tariff->resources as $resource) {
237		if ($resource->model_type === $type) {
238		return $resource;
239		}
240		}
241
242		return null;
243		}
244
245		/**
246		* @return array
247		*/
248		public function getLocations()
249		{
250		return [
251		1 => Yii::t('hipanel/server/order', 'Netherlands, Amsterdam'),
252		];
253		}
254
255		/**
256		* @return string
257		*/
258		public function getId()
259		{
260		if (!isset($this->_id)) {
261		$this->_id = hash('crc32b', implode('_', ['server', 'order', uniqid()]));
262		}
263
264		return $this->_id;
265		}
266		}
267

hiqdev / hipanel-module-server

Push — master ( 81b279...95954c )

Package B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

20 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like