DeploynautAPIFormatter::getDeploymentData() - Code Metrics - Inspection of "[wip] Adding approval functionality" - silverstripe/deploynaut - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#681)

by Sean

created 2016-10-05 04:02 UTC

DeploynautAPIFormatter::getDeploymentData() B

↳ Parent: DeploynautAPIFormatter

Complexity

Conditions	8
Paths	32

Size

Total Lines	56
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	7.3333
c	0
b	0
f	0
cc	8
eloc	44
nc	32
nop	1

How to fix Long Method

<?php

class DeploynautAPIFormatter {
namespace YourVendor;

class YourClass { }

	/**
	 * This is a per request cache of $project()->listMembers()
	 * @var null|array
	 */
	private static $_cache_project_members = null;

	/**
	 * This is a per request cache of $environment->CurrentBuild();
	 * @var null|DNDeployment
	 */
	private static $_cache_current_build = null;

	/**
	 * Return data about a single deployment for use in API response.
	 * @param DNDeployment $deployment
	 * @return array
	 */
	public function getDeploymentData(DNDeployment $deployment) {
		if (empty(self::$_cache_current_build[$deployment->EnvironmentID])) {
			self::$_cache_current_build[$deployment->EnvironmentID] = $deployment->Environment()->CurrentBuild();
		}

		$environment = $deployment->Environment();
		$project = $environment->Project();

		$deployer = $deployment->Deployer();
		$deployerData = null;
		if ($deployer && $deployer->exists()) {
			$deployerData = $this->getStackMemberData($project, $deployer);
		}
		$approver = $deployment->Approver();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		$approverData = null;
		if ($approver && $approver->exists()) {
			$approverData = $this->getStackMemberData($project, $approver);
		}

		// failover for older deployments
		$started = $deployment->Created;
		$startedNice = $deployment->obj('Created')->Nice();
		if($deployment->DeployStarted) {
			$started = $deployment->DeployStarted;
			$startedNice = $deployment->obj('DeployStarted')->Nice();
		}

		$isCurrentBuild = self::$_cache_current_build[$deployment->EnvironmentID]
			? ($deployment->ID === self::$_cache_current_build[$deployment->EnvironmentID]->ID)
			: false;

		return [
			'id' => $deployment->ID,
			'date_created' => $deployment->Created,
			'date_created_nice' => $deployment->obj('Created')->Nice(),
			'date_started' => $started,
			'date_started_nice' => $startedNice,
			'date_requested' => $deployment->DeployRequested,
			'date_requested_nice' => $deployment->obj('DeployRequested')->Nice(),
			'date_updated' => $deployment->LastEdited,
			'date_updated_nice' => $deployment->obj('LastEdited')->Nice(),
			'summary' => $deployment->Summary,

			'branch' => $deployment->Branch,
<?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.");
        }
    }

}
			'tags' => $deployment->getTags()->toArray(),
			'changes' => $deployment->getDeploymentStrategy()->getChanges(),
			'sha' => $deployment->SHA,
			'short_sha' => substr($deployment->SHA, 0, 7),
			'ref_type' => $deployment->RefType,
			'commit_message' => $deployment->getCommitMessage(),
			'commit_url' => $deployment->getCommitURL(),
			'deployer' => $deployerData,
			'approver' => $approverData,
			'state' => $deployment->State,
			'is_current_build' => $isCurrentBuild
		];
	}

	/**
	 * Return data about a particular {@link Member} of the stack for use in API response.
	 * Note that role can be null in the response. This is the case of an admin, or an operations
	 * user who can create the deployment but is not part of the stack roles.
	 *
	 * @param DNProject $project
	 * @param Member $member
	 * @return array
	 */
	public function getStackMemberData(DNProject $project, Member $member) {
		if (empty(self::$_cache_project_members[$project->ID])) {
			self::$_cache_project_members[$project->ID] = $project->listMembers();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
		}

		$role = null;
		foreach (self::$_cache_project_members[$project->ID] as $stackMember) {
			if ($stackMember['MemberID'] !== $member->ID) {
				continue;
			}
			$role = $stackMember['RoleTitle'];
		}

		return [
			'id' => $member->ID,
			'email' => $member->Email,
			'role' => $role,
			'name' => $member->getName()
		];
	}

}


1			<?php
2
3			class DeploynautAPIFormatter {
			0 ignored issues – show Coding Style introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The property $_cache_project_members 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 introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The property $_cache_current_build 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-10-05 01:39 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...
4
5			/**
6			* This is a per request cache of $project()->listMembers()
7			* @var null\|array
8			*/
9			private static $_cache_project_members = null;
10
11			/**
12			* This is a per request cache of $environment->CurrentBuild();
13			* @var null\|DNDeployment
14			*/
15			private static $_cache_current_build = null;
16
17			/**
18			* Return data about a single deployment for use in API response.
19			* @param DNDeployment $deployment
20			* @return array
21			*/
22			public function getDeploymentData(DNDeployment $deployment) {
23			if (empty(self::$_cache_current_build[$deployment->EnvironmentID])) {
24			self::$_cache_current_build[$deployment->EnvironmentID] = $deployment->Environment()->CurrentBuild();
25			}
26
27			$environment = $deployment->Environment();
28			$project = $environment->Project();
29
30			$deployer = $deployment->Deployer();
31			$deployerData = null;
32			if ($deployer && $deployer->exists()) {
33			$deployerData = $this->getStackMemberData($project, $deployer);
34			}
35			$approver = $deployment->Approver();
			0 ignored issues – show Documentation Bug introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The method `Approver` does not exist on `object<DNDeployment>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
36			$approverData = null;
37			if ($approver && $approver->exists()) {
38			$approverData = $this->getStackMemberData($project, $approver);
39			}
40
41			// failover for older deployments
42			$started = $deployment->Created;
43			$startedNice = $deployment->obj('Created')->Nice();
44			if($deployment->DeployStarted) {
45			$started = $deployment->DeployStarted;
46			$startedNice = $deployment->obj('DeployStarted')->Nice();
47			}
48
49			$isCurrentBuild = self::$_cache_current_build[$deployment->EnvironmentID]
50			? ($deployment->ID === self::$_cache_current_build[$deployment->EnvironmentID]->ID)
51			: false;
52
53			return [
54			'id' => $deployment->ID,
55			'date_created' => $deployment->Created,
56			'date_created_nice' => $deployment->obj('Created')->Nice(),
57			'date_started' => $started,
58			'date_started_nice' => $startedNice,
59			'date_requested' => $deployment->DeployRequested,
60			'date_requested_nice' => $deployment->obj('DeployRequested')->Nice(),
61			'date_updated' => $deployment->LastEdited,
62			'date_updated_nice' => $deployment->obj('LastEdited')->Nice(),
63			'summary' => $deployment->Summary,
			0 ignored issues – show Bug introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The property `Summary` does not seem to exist. Did you mean `summary_fields`? 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...
64			'branch' => $deployment->Branch,
			0 ignored issues – show Documentation introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The property `Branch` does not exist on `object<DNDeployment>`. 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...
65			'tags' => $deployment->getTags()->toArray(),
66			'changes' => $deployment->getDeploymentStrategy()->getChanges(),
67			'sha' => $deployment->SHA,
68			'short_sha' => substr($deployment->SHA, 0, 7),
69			'ref_type' => $deployment->RefType,
70			'commit_message' => $deployment->getCommitMessage(),
71			'commit_url' => $deployment->getCommitURL(),
72			'deployer' => $deployerData,
73			'approver' => $approverData,
74			'state' => $deployment->State,
75			'is_current_build' => $isCurrentBuild
76			];
77			}
78
79			/**
80			* Return data about a particular {@link Member} of the stack for use in API response.
81			* Note that role can be null in the response. This is the case of an admin, or an operations
82			* user who can create the deployment but is not part of the stack roles.
83			*
84			* @param DNProject $project
85			* @param Member $member
86			* @return array
87			*/
88			public function getStackMemberData(DNProject $project, Member $member) {
89			if (empty(self::$_cache_project_members[$project->ID])) {
90			self::$_cache_project_members[$project->ID] = $project->listMembers();
			0 ignored issues – show Documentation Bug introduced 2016-10-05 01:39 UTC by Report Bug Copy Issue Report The method `listMembers` does not exist on `object<DNProject>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
91			}
92
93			$role = null;
94			foreach (self::$_cache_project_members[$project->ID] as $stackMember) {
95			if ($stackMember['MemberID'] !== $member->ID) {
96			continue;
97			}
98			$role = $stackMember['RoleTitle'];
99			}
100
101			return [
102			'id' => $member->ID,
103			'email' => $member->Email,
104			'role' => $role,
105			'name' => $member->getName()
106			];
107			}
108
109			}
110

silverstripe / deploynaut

Pull Request — master (#681)

DeploynautAPIFormatter::getDeploymentData() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like