IssueCloner::__construct() - Code Metrics - Inspection of "Adding change log issue cloning command" - console-helpers/jira-cli - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 5433f0...117895 )

by Alexander

created 2016-11-25 13:39 UTC

IssueCloner::__construct() A

↳ Parent: IssueCloner

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	6
ccs	0
cts	5
cp	0
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php
/**
 * This file is part of the Jira-CLI library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <[email protected]>
 * @link      https://github.com/console-helpers/jira-cli
 */

namespace ConsoleHelpers\JiraCLI\Issue;


use chobie\Jira\Api;
use chobie\Jira\Issue;
use chobie\Jira\Issues\Walker;

class IssueCloner
{

	const LINK_DIRECTION_INWARD = 1;

	const LINK_DIRECTION_OUTWARD = 2;

	/**
	 * Jira REST client.
	 *
	 * @var Api
	 */
	protected $jiraApi;

	/**
	 * Specifies custom fields to copy during backporting.
	 *
	 * @var array
	 */
	private $_copyCustomFields = array(
		'Change Log Group', 'Change Log Message',
	);

	/**
	 * Custom fields map.
	 *
	 * @var array
	 */
	private $_customFieldsMap = array();

	/**
	 * Fields to query during issue search.
	 *
	 * @var array
	 */
	protected $queryFields = array('summary', 'issuelinks');

	/**
	 * IssueCloner constructor.
	 *
	 * @param Api $jira_api Jira REST client.
	 */
	public function __construct(Api $jira_api)
	{
		$this->jiraApi = $jira_api;

		$this->jiraApi->setOptions(0); // Don't expand fields.
	}

	/**
	 * Returns issues.
	 *
	 * @param string  $jql            JQL.
	 * @param string  $link_name      Link name.
	 * @param integer $link_direction Link direction.
	 *
	 * @return array
	 */
	public function getIssues($jql, $link_name, $link_direction)
	{
		$this->_buildCustomFieldsMap();

		$walker = new Walker($this->jiraApi);
		$walker->push($jql, implode(',', $this->_getQueryFields()));

		$ret = array();

		foreach ( $walker as $issue ) {
			$linked_issue = $this->_getLinkedIssue($issue, $link_name, $link_direction);

			if ( is_object($linked_issue) && $this->isAlreadyProcessed($issue, $linked_issue) ) {
				continue;
			}

			$ret[] = array($issue, $linked_issue);
		}

		return $ret;
	}

	/**
	 * Builds custom field map.
	 *
	 * @return void
	 */
	private function _buildCustomFieldsMap()
	{
		foreach ( $this->jiraApi->getFields() as $field_key => $field_data ) {
			if ( substr($field_key, 0, 12) === 'customfield_' ) {
				$this->_customFieldsMap[$field_data['name']] = $field_key;
			}
		}
	}

	/**
	 * Returns query fields.
	 *
	 * @return array
	 */
	private function _getQueryFields()
	{
		$ret = $this->queryFields;

		foreach ( $this->_copyCustomFields as $custom_field ) {
			if ( isset($this->_customFieldsMap[$custom_field]) ) {
				$ret[] = $this->_customFieldsMap[$custom_field];
			}
		}

		return $ret;
	}

	/**
	 * Returns issue, which backports given issue.
	 *
	 * @param Issue   $issue          Issue.
	 * @param string  $link_name      Link name.
	 * @param integer $link_direction Link direction.
	 *
	 * @return Issue|null
	 * @throws \InvalidArgumentException When link direction isn't valid.
	 */
	private function _getLinkedIssue(Issue $issue, $link_name, $link_direction)
	{
		foreach ( $issue->get('issuelinks') as $issue_link ) {
			if ( $issue_link['type']['name'] !== $link_name ) {
				continue;
			}

			if ( $link_direction === self::LINK_DIRECTION_INWARD ) {
				$check_key = 'inwardIssue';
			}
			elseif ( $link_direction === self::LINK_DIRECTION_OUTWARD ) {
				$check_key = 'outwardIssue';
			}
			else {
				throw new \InvalidArgumentException('The "' . $link_direction . '" link direction isn\'t valid.');
			}

			if ( array_key_exists($check_key, $issue_link) ) {
				$linked_issue = new Issue($issue_link[$check_key]);

				if ( $this->isLinkAccepted($issue, $linked_issue) ) {
					return $linked_issue;
				}
			}
		}

		return null;
	}

	/**
	 * Creates backports issues.
	 *
	 * @param Issue   $issue          Issue.
	 * @param string  $project_key    Project key.
	 * @param string  $link_name      Link name.
	 * @param integer $link_direction Link direction.
	 * @param array   $component_ids  Component IDs.
	 *
	 * @return string
	 * @throws \RuntimeException When failed to create an issue.
	 * @throws \InvalidArgumentException When link direction isn't valid.
	 */
	public function createLinkedIssue(Issue $issue, $project_key, $link_name, $link_direction, array $component_ids)
	{
		$create_fields = array(
			'description' => 'See ' . $issue->getKey() . '.',
			'components' => array(),
		);

		foreach ( $this->_copyCustomFields as $custom_field ) {
			if ( isset($this->_customFieldsMap[$custom_field]) ) {
				$custom_field_id = $this->_customFieldsMap[$custom_field];
				$create_fields[$custom_field_id] = $this->getIssueCustomField($issue, $custom_field_id);
			}
		}

		foreach ( $component_ids as $component_id ) {
			$create_fields['components'][] = array('id' => (string)$component_id);
		}

		$create_issue_result = $this->jiraApi->createIssue(
			$project_key,
			$issue->get('summary'),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			$this->getChangelogEntryIssueTypeId(),
			$create_fields
		);

		$raw_create_issue_result = $create_issue_result->getResult();

		if ( array_key_exists('errors', $raw_create_issue_result) ) {
			throw new \RuntimeException(sprintf(
				'Failed to create linked issue for "%s" issue. Errors: ' . PHP_EOL . '%s',
				$issue->getKey(),
				print_r($raw_create_issue_result['errors'], true)
			));
		}

		if ( $link_direction === self::LINK_DIRECTION_INWARD ) {
			$issue_link_result = $this->jiraApi->api(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				Api::REQUEST_POST,
				'/rest/api/2/issueLink',
				array(
					'type' => array('name' => $link_name),
					'inwardIssue' => array('key' => $raw_create_issue_result['key']),
					'outwardIssue' => array('key' => $issue->getKey()),
				)
			);
		}
		elseif ( $link_direction === self::LINK_DIRECTION_OUTWARD ) {
			$issue_link_result = $this->jiraApi->api(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
				Api::REQUEST_POST,
				'/rest/api/2/issueLink',
				array(
					'type' => array('name' => $link_name),
					'inwardIssue' => array('key' => $issue->getKey()),
					'outwardIssue' => array('key' => $raw_create_issue_result['key']),
				)
			);
		}
		else {
			throw new \InvalidArgumentException('The "' . $link_direction . '" link direction isn\'t valid.');
		}

		return $raw_create_issue_result['key'];
	}

	/**
	 * Determines if link was already processed.
	 *
	 * @param Issue $issue        Issue.
	 * @param Issue $linked_issue Linked issue.
	 *
	 * @return boolean
	 */
	protected function isAlreadyProcessed(Issue $issue, Issue $linked_issue)
	{
		return false;
	}

	/**
	 * Determines if link is accepted.
	 *
	 * @param Issue $issue        Issue.
	 * @param Issue $linked_issue Linked issue.
	 *
	 * @return boolean
	 */
	protected function isLinkAccepted(Issue $issue, Issue $linked_issue)

	{
		return true;
	}

	/**
	 * Returns ID of "Changelog Entry" issue type.
	 *
	 * @return integer
	 * @throws \LogicException When "Changelog Entry" issue type wasn't found.
	 */
	protected function getChangelogEntryIssueTypeId()
	{
		static $issue_type_id;

		if ( !isset($issue_type_id) ) {
			foreach ( $this->jiraApi->getIssueTypes() as $issue_type ) {
				if ( $issue_type->getName() === 'Changelog Entry' ) {
					$issue_type_id = $issue_type->getId();
					break;
				}
			}

			if ( !isset($issue_type_id) ) {
				throw new \LogicException('The "Changelog Entry" issue type not found.');
			}
		}

		return $issue_type_id;
	}

	/**
	 * Returns custom field value.
	 *
	 * @param Issue  $issue           Issue.
	 * @param string $custom_field_id Custom field ID.
	 *
	 * @return mixed
	 */
	protected function getIssueCustomField(Issue $issue, $custom_field_id)
	{
		$custom_field_data = $issue->get($custom_field_id);

		if ( is_array($custom_field_data) ) {
			return array('value' => $custom_field_data['value']);
		}

		return $custom_field_data;
	}

	/**
	 * Returns issue status name.
	 *
	 * @param Issue $issue Issue.
	 *
	 * @return string
	 */
	public function getIssueStatusName(Issue $issue)
	{
		$status = $issue->get('status');

		return $status['name'];
	}

}


1			<?php
2			/**
3			* This file is part of the Jira-CLI library.
4			* For the full copyright and license information, please view
5			* the LICENSE file that was distributed with this source code.
6			*
7			* @copyright Alexander Obuhovich <[email protected]>
8			* @link https://github.com/console-helpers/jira-cli
9			*/
10
11			namespace ConsoleHelpers\JiraCLI\Issue;
12
13
14			use chobie\Jira\Api;
15			use chobie\Jira\Issue;
16			use chobie\Jira\Issues\Walker;
17
18			class IssueCloner
19			{
20
21			const LINK_DIRECTION_INWARD = 1;
22
23			const LINK_DIRECTION_OUTWARD = 2;
24
25			/**
26			* Jira REST client.
27			*
28			* @var Api
29			*/
30			protected $jiraApi;
31
32			/**
33			* Specifies custom fields to copy during backporting.
34			*
35			* @var array
36			*/
37			private $_copyCustomFields = array(
38			'Change Log Group', 'Change Log Message',
39			);
40
41			/**
42			* Custom fields map.
43			*
44			* @var array
45			*/
46			private $_customFieldsMap = array();
47
48			/**
49			* Fields to query during issue search.
50			*
51			* @var array
52			*/
53			protected $queryFields = array('summary', 'issuelinks');
54
55			/**
56			* IssueCloner constructor.
57			*
58			* @param Api $jira_api Jira REST client.
59			*/
60			public function __construct(Api $jira_api)
61			{
62			$this->jiraApi = $jira_api;
63
64			$this->jiraApi->setOptions(0); // Don't expand fields.
65			}
66
67			/**
68			* Returns issues.
69			*
70			* @param string $jql JQL.
71			* @param string $link_name Link name.
72			* @param integer $link_direction Link direction.
73			*
74			* @return array
75			*/
76			public function getIssues($jql, $link_name, $link_direction)
77			{
78			$this->_buildCustomFieldsMap();
79
80			$walker = new Walker($this->jiraApi);
81			$walker->push($jql, implode(',', $this->_getQueryFields()));
82
83			$ret = array();
84
85			foreach ( $walker as $issue ) {
86			$linked_issue = $this->_getLinkedIssue($issue, $link_name, $link_direction);
87
88			if ( is_object($linked_issue) && $this->isAlreadyProcessed($issue, $linked_issue) ) {
89			continue;
90			}
91
92			$ret[] = array($issue, $linked_issue);
93			}
94
95			return $ret;
96			}
97
98			/**
99			* Builds custom field map.
100			*
101			* @return void
102			*/
103			private function _buildCustomFieldsMap()
104			{
105			foreach ( $this->jiraApi->getFields() as $field_key => $field_data ) {
106			if ( substr($field_key, 0, 12) === 'customfield_' ) {
107			$this->_customFieldsMap[$field_data['name']] = $field_key;
108			}
109			}
110			}
111
112			/**
113			* Returns query fields.
114			*
115			* @return array
116			*/
117			private function _getQueryFields()
118			{
119			$ret = $this->queryFields;
120
121			foreach ( $this->_copyCustomFields as $custom_field ) {
122			if ( isset($this->_customFieldsMap[$custom_field]) ) {
123			$ret[] = $this->_customFieldsMap[$custom_field];
124			}
125			}
126
127			return $ret;
128			}
129
130			/**
131			* Returns issue, which backports given issue.
132			*
133			* @param Issue $issue Issue.
134			* @param string $link_name Link name.
135			* @param integer $link_direction Link direction.
136			*
137			* @return Issue\|null
138			* @throws \InvalidArgumentException When link direction isn't valid.
139			*/
140			private function _getLinkedIssue(Issue $issue, $link_name, $link_direction)
141			{
142			foreach ( $issue->get('issuelinks') as $issue_link ) {
143			if ( $issue_link['type']['name'] !== $link_name ) {
144			continue;
145			}
146
147			if ( $link_direction === self::LINK_DIRECTION_INWARD ) {
148			$check_key = 'inwardIssue';
149			}
150			elseif ( $link_direction === self::LINK_DIRECTION_OUTWARD ) {
151			$check_key = 'outwardIssue';
152			}
153			else {
154			throw new \InvalidArgumentException('The "' . $link_direction . '" link direction isn\'t valid.');
155			}
156
157			if ( array_key_exists($check_key, $issue_link) ) {
158			$linked_issue = new Issue($issue_link[$check_key]);
159
160			if ( $this->isLinkAccepted($issue, $linked_issue) ) {
161			return $linked_issue;
162			}
163			}
164			}
165
166			return null;
167			}
168
169			/**
170			* Creates backports issues.
171			*
172			* @param Issue $issue Issue.
173			* @param string $project_key Project key.
174			* @param string $link_name Link name.
175			* @param integer $link_direction Link direction.
176			* @param array $component_ids Component IDs.
177			*
178			* @return string
179			* @throws \RuntimeException When failed to create an issue.
180			* @throws \InvalidArgumentException When link direction isn't valid.
181			*/
182			public function createLinkedIssue(Issue $issue, $project_key, $link_name, $link_direction, array $component_ids)
183			{
184			$create_fields = array(
185			'description' => 'See ' . $issue->getKey() . '.',
186			'components' => array(),
187			);
188
189			foreach ( $this->_copyCustomFields as $custom_field ) {
190			if ( isset($this->_customFieldsMap[$custom_field]) ) {
191			$custom_field_id = $this->_customFieldsMap[$custom_field];
192			$create_fields[$custom_field_id] = $this->getIssueCustomField($issue, $custom_field_id);
193			}
194			}
195
196			foreach ( $component_ids as $component_id ) {
197			$create_fields['components'][] = array('id' => (string)$component_id);
198			}
199
200			$create_issue_result = $this->jiraApi->createIssue(
201			$project_key,
202			$issue->get('summary'),
			1 ignored issue – show Documentation introduced 2016-11-25 13:41 UTC by Report Bug Copy Issue Report `$issue->get('summary')` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
203			$this->getChangelogEntryIssueTypeId(),
204			$create_fields
205			);
206
207			$raw_create_issue_result = $create_issue_result->getResult();
208
209			if ( array_key_exists('errors', $raw_create_issue_result) ) {
210			throw new \RuntimeException(sprintf(
211			'Failed to create linked issue for "%s" issue. Errors: ' . PHP_EOL . '%s',
212			$issue->getKey(),
213			print_r($raw_create_issue_result['errors'], true)
214			));
215			}
216
217			if ( $link_direction === self::LINK_DIRECTION_INWARD ) {
218			$issue_link_result = $this->jiraApi->api(
			1 ignored issue – show Unused Code introduced 2016-11-25 13:41 UTC by Report Bug Copy Issue Report `$issue_link_result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
219			Api::REQUEST_POST,
220			'/rest/api/2/issueLink',
221			array(
222			'type' => array('name' => $link_name),
223			'inwardIssue' => array('key' => $raw_create_issue_result['key']),
224			'outwardIssue' => array('key' => $issue->getKey()),
225			)
226			);
227			}
228			elseif ( $link_direction === self::LINK_DIRECTION_OUTWARD ) {
229			$issue_link_result = $this->jiraApi->api(
			1 ignored issue – show Unused Code introduced 2016-11-25 13:41 UTC by Report Bug Copy Issue Report `$issue_link_result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
230			Api::REQUEST_POST,
231			'/rest/api/2/issueLink',
232			array(
233			'type' => array('name' => $link_name),
234			'inwardIssue' => array('key' => $issue->getKey()),
235			'outwardIssue' => array('key' => $raw_create_issue_result['key']),
236			)
237			);
238			}
239			else {
240			throw new \InvalidArgumentException('The "' . $link_direction . '" link direction isn\'t valid.');
241			}
242
243			return $raw_create_issue_result['key'];
244			}
245
246			/**
247			* Determines if link was already processed.
248			*
249			* @param Issue $issue Issue.
250			* @param Issue $linked_issue Linked issue.
251			*
252			* @return boolean
253			*/
254			protected function isAlreadyProcessed(Issue $issue, Issue $linked_issue)
255			{
256			return false;
257			}
258
259			/**
260			* Determines if link is accepted.
261			*
262			* @param Issue $issue Issue.
263			* @param Issue $linked_issue Linked issue.
264			*
265			* @return boolean
266			*/
267			protected function isLinkAccepted(Issue $issue, Issue $linked_issue)
			1 ignored issue – show Unused Code introduced 2016-11-25 13:41 UTC by Report Bug Copy Issue Report The parameter `$issue` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
268			{
269			return true;
270			}
271
272			/**
273			* Returns ID of "Changelog Entry" issue type.
274			*
275			* @return integer
276			* @throws \LogicException When "Changelog Entry" issue type wasn't found.
277			*/
278			protected function getChangelogEntryIssueTypeId()
279			{
280			static $issue_type_id;
281
282			if ( !isset($issue_type_id) ) {
283			foreach ( $this->jiraApi->getIssueTypes() as $issue_type ) {
284			if ( $issue_type->getName() === 'Changelog Entry' ) {
285			$issue_type_id = $issue_type->getId();
286			break;
287			}
288			}
289
290			if ( !isset($issue_type_id) ) {
291			throw new \LogicException('The "Changelog Entry" issue type not found.');
292			}
293			}
294
295			return $issue_type_id;
296			}
297
298			/**
299			* Returns custom field value.
300			*
301			* @param Issue $issue Issue.
302			* @param string $custom_field_id Custom field ID.
303			*
304			* @return mixed
305			*/
306			protected function getIssueCustomField(Issue $issue, $custom_field_id)
307			{
308			$custom_field_data = $issue->get($custom_field_id);
309
310			if ( is_array($custom_field_data) ) {
311			return array('value' => $custom_field_data['value']);
312			}
313
314			return $custom_field_data;
315			}
316
317			/**
318			* Returns issue status name.
319			*
320			* @param Issue $issue Issue.
321			*
322			* @return string
323			*/
324			public function getIssueStatusName(Issue $issue)
325			{
326			$status = $issue->get('status');
327
328			return $status['name'];
329			}
330
331			}
332

console-helpers / jira-cli

Push — master ( 5433f0...117895 )

IssueCloner::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like