ReviewCommand::processMerged() - Code Metrics - NeoBlack/T3Bot - Measure and Improve Code Quality continuously with Scrutinizer

ReviewCommand::processMerged() A
last analyzed 2019-10-31 09:04 UTC

↳ Parent: ReviewCommand

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	9
cts	9
cp	1
rs	9.7666
c	0
b	0
f	0
cc	3
nc	4
nop	0
crap	3

<?php
/**
 * T3Bot.
 *
 * @author Frank Nägler <[email protected]>
 *
 * @link http://www.t3bot.de
 * @link http://wiki.typo3.org/T3Bot
 */
namespace T3Bot\Commands;

use Slack\Payload;
use Slack\RealTimeClient;
use T3Bot\Slack\Message;

/**
 * Class ReviewCommand.
 *
 * @property string commandName
 * @property array helpCommands
 */
class ReviewCommand extends AbstractCommand
{
    /**
     * AbstractCommand constructor.
     *
     * @param Payload $payload
     * @param RealTimeClient $client
     * @param array|null $configuration
     */
    public function __construct(Payload $payload, RealTimeClient $client, array $configuration = null)
    {
        $this->commandName = 'review';
        $this->helpCommands = [
            'help' => 'shows this help',
            'count [PROJECT=Packages/TYPO3.CMS]' => 'shows the number of currently open reviews for [PROJECT]',
            'random' => 'shows a random open review',
            'show [Ref-ID] [[Ref-ID-2] [[Ref-ID-n]]]' => 'shows the review by given change number(s). Do not use separators other than space.',
            'user [username] [PROJECT=Packages/TYPO3.CMS]' => 'shows the open reviews by given username for [PROJECT]',
            'query [searchQuery]' => 'shows the results for given [searchQuery], max limit is 50',
            'merged [YYYY-MM-DD]' => 'shows a count of merged patches on master since given date',
        ];
        parent::__construct($payload, $client, $configuration);
    }

    /**
     * process count.
     *
     * @return string
     */
    protected function processCount() : string
    {
        $project = !empty($this->params[1]) ? $this->params[1] : 'Packages/TYPO3.CMS';
        $result = $this->queryGerrit("is:open branch:master -message:WIP project:{$project}");
        $count = count($result);
        $result = $this->queryGerrit("label:Code-Review=-1 is:open branch:master -message:WIP project:{$project}");
        $countMinus1 = count($result);
        $result = $this->queryGerrit("label:Code-Review=-2 is:open branch:master -message:WIP project:{$project}");
        $countMinus2 = count($result);

        $returnString = '';
        $returnString .= 'There are currently ' . $this->bold($count) . ' open reviews for project '
            . $this->italic($project) . ' and branch master on <https://review.typo3.org/#/q/project:' . $project
            . '+status:open+branch:master|https://review.typo3.org>' . chr(10);
        $returnString .= $this->bold($countMinus1) . ' of ' . $this->bold($count) . ' open reviews voted with '
            . $this->bold('-1') . ' <https://review.typo3.org/#/q/label:Code-Review%253D-1+is:open+branch:'
            . 'master+project:' . $project . '|Check now> ' . chr(10);
        $returnString .= $this->bold($countMinus2) . ' of ' . $this->bold($count) . ' open reviews voted with '
            . $this->bold('-2') . ' <https://review.typo3.org/#/q/label:Code-Review%253D-2+is:open+branch:'
            . 'master+project:' . $project . '|Check now>';

        return $returnString;
    }

    /**
     * process random.
     *
     * @return Message
     */
    protected function processRandom() : Message
    {
        /** @var array $result */
        $result = $this->queryGerrit('is:open project:Packages/TYPO3.CMS');
        $item = $result[array_rand($result)];

        return $this->buildReviewMessage($item);
    }

    /**
     * process user.
     *
     * @return string
     */
    protected function processUser() : string
    {
        $username = $this->params[1] ?? null;
        $project = $this->params[2] ?? 'Packages/TYPO3.CMS';
        if ($username === null) {
            return 'hey, I need a username!';
        }
        $results = $this->queryGerrit('is:open owner:"' . $username . '" project:' . $project);
        if (!empty($results)) {

            $listOfItems = ['*Here are the results for ' . $username . '*:'];
            foreach ($results as $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $listOfItems[] = $this->buildReviewLine($item);
            }
            return implode(chr(10), $listOfItems);
        }
        return $username . ' has no open reviews or username is unknown';
    }

    /**
     * process count.
     *
     * @return string|Message
     */
    protected function processShow()
    {
        $urlPattern = '/http[s]*:\/\/review.typo3.org\/[#\/c]*([\d]*)(?:.*)/i';
        $refId = $this->params[1] ?? 0;
        if (preg_match_all($urlPattern, $refId, $matches)) {
            $refId = (int) $matches[1][0];
        } else {
            $refId = (int) $refId;
        }
        if ($refId === 0) {
            return 'hey, I need at least one change number!';
        }
        $paramsCount = count($this->params);
        if ($paramsCount > 2) {
            $returnMessage = $this->buildReviewLineOutput();
        } else {
            $returnMessage = $this->buildReviewMessageOutput($refId);
        }

        return $returnMessage;
    }

    /**
     * @return string
     */
    protected function buildReviewLineOutput() : string
    {
        $paramsCount = count($this->params);
        $changeIds = [];
        for ($i = 1; $i < $paramsCount; ++$i) {
            $changeIds[] = 'change:' . $this->params[$i];
        }
        $result = $this->queryGerrit(implode(' OR ', $changeIds));
        $listOfItems = [];
        if (is_array($result)) {
            foreach ($result as $item) {
                $listOfItems[] = $this->buildReviewLine($item);
            }
        }
        return implode(chr(10), $listOfItems);
    }

    /**
     * @param int $refId
     *
     * @return string|Message
     */
    protected function buildReviewMessageOutput(int $refId)
    {
        $result = $this->queryGerrit('change:' . $refId);
        if (!empty($result)) {
            foreach ($result as $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                if ($item->_number === $refId) {
                    return $this->buildReviewMessage($item);
                }
            }
        }
        return "{$refId} not found, sorry!";
    }

    /**
     * process query.
     *
     * @return string
     */
    protected function processQuery() : string
    {
        array_shift($this->params);
        $query = trim(implode(' ', $this->params));
        if ($query === '') {
            return 'hey, I need a query!';
        }

        $results = $this->queryGerrit('limit:50 ' . $query);
        if (!empty($results)) {

            $listOfItems = ["*Here are the results for {$query}*:"];
            foreach ($results as $item) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $listOfItems[] = $this->buildReviewLine($item);
            }
            return implode(chr(10), $listOfItems);
        }

        return "{$query} not found, sorry!";
    }

    /**
     * @return string
     */
    protected function processMerged() : string
    {
        $query = 'project:Packages/TYPO3.CMS status:merged after:###DATE### branch:master';

        $date = !empty($this->params[1]) ? $this->params[1] : '';
        if (!$this->isDateFormatCorrect($date)) {
            return 'hey, I need a date in the format YYYY-MM-DD!';
        }
        $query = str_replace('###DATE###', $date, $query);
        $result = $this->queryGerrit($query);

        $cnt = count($result);

        return 'Good job folks, since ' . $date . ' you merged *' . $cnt . '* patches into master';
    }

    /**
     * check format of given date.
     *
     * @param $date
     *
     * @return bool
     */
    protected function isDateFormatCorrect($date) : bool
    {
        return preg_match('/[\d]{4}-[\d]{2}-[\d]{2}/', $date) === 1;
    }
}


1			<?php
2			/**
3			* T3Bot.
4			*
5			* @author Frank Nägler <[email protected]>
6			*
7			* @link http://www.t3bot.de
8			* @link http://wiki.typo3.org/T3Bot
9			*/
10			namespace T3Bot\Commands;
11
12			use Slack\Payload;
13			use Slack\RealTimeClient;
14			use T3Bot\Slack\Message;
15
16			/**
17			* Class ReviewCommand.
18			*
19			* @property string commandName
20			* @property array helpCommands
21			*/
22			class ReviewCommand extends AbstractCommand
23			{
24			/**
25			* AbstractCommand constructor.
26			*
27			* @param Payload $payload
28			* @param RealTimeClient $client
29			* @param array\|null $configuration
30			*/
31	27		public function __construct(Payload $payload, RealTimeClient $client, array $configuration = null)
32			{
33	27		$this->commandName = 'review';
34	27		$this->helpCommands = [
35			'help' => 'shows this help',
36			'count [PROJECT=Packages/TYPO3.CMS]' => 'shows the number of currently open reviews for [PROJECT]',
37			'random' => 'shows a random open review',
38			'show [Ref-ID] [[Ref-ID-2] [[Ref-ID-n]]]' => 'shows the review by given change number(s). Do not use separators other than space.',
39			'user [username] [PROJECT=Packages/TYPO3.CMS]' => 'shows the open reviews by given username for [PROJECT]',
40			'query [searchQuery]' => 'shows the results for given [searchQuery], max limit is 50',
41			'merged [YYYY-MM-DD]' => 'shows a count of merged patches on master since given date',
42			];
43	27		parent::__construct($payload, $client, $configuration);
44	27		}
45
46			/**
47			* process count.
48			*
49			* @return string
50			*/
51	1		protected function processCount() : string
52			{
53	1		$project = !empty($this->params[1]) ? $this->params[1] : 'Packages/TYPO3.CMS';
54	1		$result = $this->queryGerrit("is:open branch:master -message:WIP project:{$project}");
55	1		$count = count($result);
56	1		$result = $this->queryGerrit("label:Code-Review=-1 is:open branch:master -message:WIP project:{$project}");
57	1		$countMinus1 = count($result);
58	1		$result = $this->queryGerrit("label:Code-Review=-2 is:open branch:master -message:WIP project:{$project}");
59	1		$countMinus2 = count($result);
60
61	1		$returnString = '';
62	1		$returnString .= 'There are currently ' . $this->bold($count) . ' open reviews for project '
63	1		. $this->italic($project) . ' and branch master on <https://review.typo3.org/#/q/project:' . $project
64	1		. '+status:open+branch:master\|https://review.typo3.org>' . chr(10);
65	1		$returnString .= $this->bold($countMinus1) . ' of ' . $this->bold($count) . ' open reviews voted with '
66	1		. $this->bold('-1') . ' <https://review.typo3.org/#/q/label:Code-Review%253D-1+is:open+branch:'
67	1		. 'master+project:' . $project . '\|Check now> ' . chr(10);
68	1		$returnString .= $this->bold($countMinus2) . ' of ' . $this->bold($count) . ' open reviews voted with '
69	1		. $this->bold('-2') . ' <https://review.typo3.org/#/q/label:Code-Review%253D-2+is:open+branch:'
70	1		. 'master+project:' . $project . '\|Check now>';
71
72	1		return $returnString;
73			}
74
75			/**
76			* process random.
77			*
78			* @return Message
79			*/
80	1		protected function processRandom() : Message
81			{
82			/** @var array $result */
83	1		$result = $this->queryGerrit('is:open project:Packages/TYPO3.CMS');
84	1		$item = $result[array_rand($result)];
85
86	1		return $this->buildReviewMessage($item);
87			}
88
89			/**
90			* process user.
91			*
92			* @return string
93			*/
94	3		protected function processUser() : string
95			{
96	3		$username = $this->params[1] ?? null;
97	3		$project = $this->params[2] ?? 'Packages/TYPO3.CMS';
98	3		if ($username === null) {
99	1		return 'hey, I need a username!';
100			}
101	2		$results = $this->queryGerrit('is:open owner:"' . $username . '" project:' . $project);
102	2	View Code Duplication	if (!empty($results)) {
			0 ignored issues – show Duplication introduced 2017-07-22 20:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
103	1		$listOfItems = ['Here are the results for ' . $username . ':'];
104	1		foreach ($results as $item) {
			0 ignored issues – show Bug introduced 2016-03-28 19:38 UTC by Report Bug Copy Issue Report The expression `$results` of type `object<stdClass>\|array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
105	1		$listOfItems[] = $this->buildReviewLine($item);
106			}
107	1		return implode(chr(10), $listOfItems);
108			}
109	1		return $username . ' has no open reviews or username is unknown';
110			}
111
112			/**
113			* process count.
114			*
115			* @return string\|Message
116			*/
117	14		protected function processShow()
118			{
119	14		$urlPattern = '/http[s]:\/\/review.typo3.org\/[#\/c]([\d])(?:.)/i';
120	14		$refId = $this->params[1] ?? 0;
121	14		if (preg_match_all($urlPattern, $refId, $matches)) {
122	4		$refId = (int) $matches[1][0];
123			} else {
124	10		$refId = (int) $refId;
125			}
126	14		if ($refId === 0) {
127	2		return 'hey, I need at least one change number!';
128			}
129	12		$paramsCount = count($this->params);
130	12		if ($paramsCount > 2) {
131	1		$returnMessage = $this->buildReviewLineOutput();
132			} else {
133	11		$returnMessage = $this->buildReviewMessageOutput($refId);
134			}
135
136	12		return $returnMessage;
137			}
138
139			/**
140			* @return string
141			*/
142	1		protected function buildReviewLineOutput() : string
143			{
144	1		$paramsCount = count($this->params);
145	1		$changeIds = [];
146	1		for ($i = 1; $i < $paramsCount; ++$i) {
147	1		$changeIds[] = 'change:' . $this->params[$i];
148			}
149	1		$result = $this->queryGerrit(implode(' OR ', $changeIds));
150	1		$listOfItems = [];
151	1		if (is_array($result)) {
152	1		foreach ($result as $item) {
153	1		$listOfItems[] = $this->buildReviewLine($item);
154			}
155			}
156	1		return implode(chr(10), $listOfItems);
157			}
158
159			/**
160			* @param int $refId
161			*
162			* @return string\|Message
163			*/
164	11		protected function buildReviewMessageOutput(int $refId)
165			{
166	11		$result = $this->queryGerrit('change:' . $refId);
167	11		if (!empty($result)) {
168	10		foreach ($result as $item) {
			0 ignored issues – show Bug introduced 2017-07-23 10:26 UTC by Report Bug Copy Issue Report The expression `$result` of type `object<stdClass>\|array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
169	10		if ($item->_number === $refId) {
170	10		return $this->buildReviewMessage($item);
171			}
172			}
173			}
174	1		return "{$refId} not found, sorry!";
175			}
176
177			/**
178			* process query.
179			*
180			* @return string
181			*/
182	3		protected function processQuery() : string
183			{
184	3		array_shift($this->params);
185	3		$query = trim(implode(' ', $this->params));
186	3		if ($query === '') {
187	1		return 'hey, I need a query!';
188			}
189
190	2		$results = $this->queryGerrit('limit:50 ' . $query);
191	2	View Code Duplication	if (!empty($results)) {
			0 ignored issues – show Duplication introduced 2017-07-22 20:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
192	1		$listOfItems = ["Here are the results for {$query}:"];
193	1		foreach ($results as $item) {
			0 ignored issues – show Bug introduced 2016-03-28 19:38 UTC by Report Bug Copy Issue Report The expression `$results` of type `object<stdClass>\|array\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
194	1		$listOfItems[] = $this->buildReviewLine($item);
195			}
196	1		return implode(chr(10), $listOfItems);
197			}
198
199	1		return "{$query} not found, sorry!";
200			}
201
202			/**
203			* @return string
204			*/
205	3		protected function processMerged() : string
206			{
207	3		$query = 'project:Packages/TYPO3.CMS status:merged after:###DATE### branch:master';
208
209	3		$date = !empty($this->params[1]) ? $this->params[1] : '';
210	3		if (!$this->isDateFormatCorrect($date)) {
211	2		return 'hey, I need a date in the format YYYY-MM-DD!';
212			}
213	1		$query = str_replace('###DATE###', $date, $query);
214	1		$result = $this->queryGerrit($query);
215
216	1		$cnt = count($result);
217
218	1		return 'Good job folks, since ' . $date . ' you merged ' . $cnt . ' patches into master';
219			}
220
221			/**
222			* check format of given date.
223			*
224			* @param $date
225			*
226			* @return bool
227			*/
228	3		protected function isDateFormatCorrect($date) : bool
229			{
230	3		return preg_match('/[\d]{4}-[\d]{2}-[\d]{2}/', $date) === 1;
231			}
232			}
233

NeoBlack / T3Bot

ReviewCommand::processMerged() A last analyzed 2019-10-31 09:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ReviewCommand::processMerged() A
last analyzed 2019-10-31 09:04 UTC