EnvironmentOverview - Code Metrics - Inspection of "Adding approval functionality" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#681)

by Sean

created 2016-10-06 00:00 UTC

EnvironmentOverview A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	95
Duplicated Lines	9.47 %

Coupling/Cohesion

Components	2
Dependencies	5

Importance

Changes

Metric	Value
wmc	6
lcom	2
cbo	5
dl	9
loc	95
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	9	9	2
A	index()	0	11	2
A	Link()	0	3	1
B	getModel()	0	31	1

How to fix Duplicated Code

<?php

/**
 * This aims to be a simple controller that only kicks off the rendering on the react
 * components. It passes a model to the frontend with URLS to dispatchers that takes
 * care of various actions, like git fetching, planning, approvals and so on.
 */
class EnvironmentOverview extends Dispatcher {
namespace YourVendor;

class YourClass { }

	const ACTION_OVERVIEW = 'overview';

	/**
	 * @var array
	 */
	private static $action_types = [

		self::ACTION_OVERVIEW
	];

	/**
	 * The "deployment" action here should only go to index, it gets used by
	 * the frontend routing.
	 */
	private static $allowed_actions = [

		'deployment'
	];

	public function init() {

		parent::init();
		$this->project = $this->getCurrentProject();

		if (!$this->project) {

			return $this->project404Response();
		}
		// Performs canView permission check by limiting visible projects
		$this->environment = $this->getCurrentEnvironment($this->project);
<?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 \SS_HTTPRequest $request
	 *
	 * @return \HTMLText|\SS_HTTPResponse
	 */
	public function index(\SS_HTTPRequest $request) {
		if (!$this->environment) {
<?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.");
        }
    }

}
			return $this->environment404Response();
		}

		$this->setCurrentActionType(self::ACTION_OVERVIEW);

		return $this->customise([
			'Environment' => $this->environment
<?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.");
        }
    }

}
		])->renderWith(['EnvironmentOverview', 'DNRoot']);
	}

	/**
	 * @return string
	 */
	public function Link() {
		return $this->environment->Link();
<?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.");
        }
    }

}
	}

	/**
	 * The model includes the CSRF tokens and the various API
	 * endpoints that the front end might be interested in.
	 *
	 * @param string $name
	 *
	 * @return array
	 */
	public function getModel($name = '') {
		$base = Director::absoluteBaseURL();
		return [
			'basename' => Director::baseURL() . $this->getCurrentEnvironment()->Link('overview'),
			'dispatchers' => [
				'git' => $base . $this->getCurrentProject()->Link('git'),
				'plan' => $base . $this->getCurrentEnvironment()->Link('plan'),
				'deploys' => $base . $this->getCurrentEnvironment()->Link('deploys'),
				'approvals' => $base . $this->getCurrentEnvironment()->Link('approvals')
			],
			'api_auth' => [
				'name' => $this->getSecurityToken()->getName(),
				'value' => $this->getSecurityToken()->getValue()
			],
			'environment' => [
				'id' => $this->environment->ID,
<?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.");
        }
    }

}
				'name' => $this->environment->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.");
        }
    }

}
				'usage' => $this->environment->Usage
<?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.");
        }
    }

}
			],
			'user' => [
				'can_approve' => $this->getCurrentProject()->allowed(
					ApprovalsDispatcher::ALLOW_APPROVAL,
					Member::currentUser()

				),
				'can_bypass_approval' => $this->getCurrentProject()->allowed(
					ApprovalsDispatcher::ALLOW_APPROVAL_BYPASS,
					Member::currentUser()

				)
			]
		];
	}

}


1		<?php
2
3		/**
4		* This aims to be a simple controller that only kicks off the rendering on the react
5		* components. It passes a model to the frontend with URLS to dispatchers that takes
6		* care of various actions, like git fetching, planning, approvals and so on.
7		*/
8		class EnvironmentOverview extends Dispatcher {
		0 ignored issues – show Coding Style introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report The property $action_types is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style Compatibility introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history... Coding Style introduced 2016-09-21 02:09 UTC by Report Bug Copy Issue Report The property $allowed_actions is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
9
10		const ACTION_OVERVIEW = 'overview';
11
12		/**
13		* @var array
14		*/
15		private static $action_types = [
		0 ignored issues – show Comprehensibility introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-09-09 01:22 UTC by Report Bug Copy Issue Report The property `$action_types` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
16		self::ACTION_OVERVIEW
17		];
18
19		/**
20		* The "deployment" action here should only go to index, it gets used by
21		* the frontend routing.
22		*/
23		private static $allowed_actions = [
		0 ignored issues – show Comprehensibility introduced 2016-09-21 02:09 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
24		'deployment'
25		];
26
27	View Code Duplication	public function init() {
		0 ignored issues – show Duplication introduced 2016-09-05 23:47 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...
28		parent::init();
29		$this->project = $this->getCurrentProject();
		0 ignored issues – show Bug introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `project` does not seem to exist. Did you mean `_project_cache`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
30		if (!$this->project) {
		0 ignored issues – show Bug introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `project` does not seem to exist. Did you mean `_project_cache`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
31		return $this->project404Response();
32		}
33		// Performs canView permission check by limiting visible projects
34		$this->environment = $this->getCurrentEnvironment($this->project);
		0 ignored issues – show Documentation introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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... Bug introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `project` does not seem to exist. Did you mean `_project_cache`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
35		}
36
37		/**
38		*
39		* @param \SS_HTTPRequest $request
40		*
41		* @return \HTMLText\|\SS_HTTPResponse
42		*/
43		public function index(\SS_HTTPRequest $request) {
44		if (!$this->environment) {
		0 ignored issues – show Documentation introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
45		return $this->environment404Response();
46		}
47
48		$this->setCurrentActionType(self::ACTION_OVERVIEW);
49
50		return $this->customise([
51		'Environment' => $this->environment
		0 ignored issues – show Documentation introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
52		])->renderWith(['EnvironmentOverview', 'DNRoot']);
53		}
54
55		/**
56		* @return string
57		*/
58		public function Link() {
59		return $this->environment->Link();
		0 ignored issues – show Documentation introduced 2016-09-05 23:47 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
60		}
61
62		/**
63		* The model includes the CSRF tokens and the various API
64		* endpoints that the front end might be interested in.
65		*
66		* @param string $name
67		*
68		* @return array
69		*/
70		public function getModel($name = '') {
71		$base = Director::absoluteBaseURL();
72		return [
73		'basename' => Director::baseURL() . $this->getCurrentEnvironment()->Link('overview'),
74		'dispatchers' => [
75		'git' => $base . $this->getCurrentProject()->Link('git'),
76		'plan' => $base . $this->getCurrentEnvironment()->Link('plan'),
77		'deploys' => $base . $this->getCurrentEnvironment()->Link('deploys'),
78		'approvals' => $base . $this->getCurrentEnvironment()->Link('approvals')
79		],
80		'api_auth' => [
81		'name' => $this->getSecurityToken()->getName(),
82		'value' => $this->getSecurityToken()->getValue()
83		],
84		'environment' => [
85		'id' => $this->environment->ID,
		0 ignored issues – show Documentation introduced 2016-09-19 05:06 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
86		'name' => $this->environment->Name,
		0 ignored issues – show Documentation introduced 2016-09-19 05:06 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
87		'usage' => $this->environment->Usage
		0 ignored issues – show Documentation introduced 2016-09-19 05:06 UTC by Report Bug Copy Issue Report The property `environment` does not exist on `object<EnvironmentOverview>`. 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...
88		],
89		'user' => [
90		'can_approve' => $this->getCurrentProject()->allowed(
91		ApprovalsDispatcher::ALLOW_APPROVAL,
92		Member::currentUser()
		0 ignored issues – show Bug introduced 2016-10-05 04:06 UTC by Report Bug Copy Issue Report It seems like `\Member::currentUser()` targeting `Member::currentUser()` can also be of type `object<DataObject>`; however, `DNProject::allowed()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
93		),
94		'can_bypass_approval' => $this->getCurrentProject()->allowed(
95		ApprovalsDispatcher::ALLOW_APPROVAL_BYPASS,
96		Member::currentUser()
		0 ignored issues – show Bug introduced 2016-10-06 00:05 UTC by Report Bug Copy Issue Report It seems like `\Member::currentUser()` targeting `Member::currentUser()` can also be of type `object<DataObject>`; however, `DNProject::allowed()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
97		)
98		]
99		];
100		}
101
102		}
103

silverstripe / deploynaut

Pull Request — master (#681)

EnvironmentOverview A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like