MessageUtility::extractCommandName() - Code Metrics - Inspection of "Simplify the function" - iranianpep/botonomous - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c60756...531e59 )

by Ehsan

created 2017-07-17 13:21 UTC

MessageUtility::extractCommandName() A

↳ Parent: MessageUtility

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

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

<?php

namespace Botonomous\utility;

use Botonomous\CommandContainer;

/**
 * Class MessageUtility.
 */
class MessageUtility extends AbstractUtility
{
    /**
     * Remove the mentioned bot username from the message.
     *
     * @param $message
     *
     * @throws \Exception
     *
     * @return string
     */
    public function removeMentionedBot($message)
    {
        $userLink = $this->getUserLink();

        return preg_replace("/{$userLink}/", '', $message, 1);
    }

    /**
     * Check if the bot user id is mentioned in the message.
     *
     * @param $message
     *
     * @throws \Exception
     *
     * @return bool
     */
    public function isBotMentioned($message)
    {
        $userLink = $this->getUserLink();

        return (new StringUtility())->findInString($userLink, $message, false);
    }

    /**
     * Return command name in the message.
     *
     * @param $message
     *
     * @return null|string
     */
    public function extractCommandName($message)
    {
        // remove the bot mention if it exists
        $message = $this->removeMentionedBot($message);

        /**
         * Command must start with / and at the beginning of the sentence.
         */
        $commandPrefix = $this->getConfig()->get('commandPrefix');
        $commandPrefix = preg_quote($commandPrefix, '/');

        $pattern = '/^('.$commandPrefix.'\w{1,})/';

        preg_match($pattern, ltrim($message), $groups);

        // If command is found, remove command prefix from the beginning of the command
        return isset($groups[1]) ? ltrim($groups[1], $commandPrefix) : null;
    }

    /**
     * Return command details in the message.
     *
     * @param $message
     *
     * @return \Botonomous\Command|null
     */
    public function extractCommandDetails($message)
    {
        // first get the command name
        $command = $this->extractCommandName($message);

        // then get the command details
        return (new CommandContainer())->getAsObject($command);
    }

    /**
     * @param $triggerWord
     * @param $message
     *
     * @return string
     */
    public function removeTriggerWord($message, $triggerWord)
    {
        $count = 1;

        return ltrim(str_replace($triggerWord, '', $message, $count));
    }

    /**
     * @param        $userId
     * @param string $userName
     *
     * @throws \Exception
     *
     * @return string
     */
    public function linkToUser($userId, $userName = '')
    {
        if (empty($userId)) {
            throw new \Exception('User id is not provided');
        }

        if (!empty($userName)) {
            $userName = "|{$userName}";
        }

        return "<@{$userId}{$userName}>";
    }

    /**
     * @return string
     */
    private function getUserLink()
    {
        return $this->linkToUser($this->getConfig()->get('botUserId'));
    }

    public function keywordPos(array $keywords, $message)
    {
        $found = [];

        if (empty($keywords)) {
            return $found;
        }

        usort($keywords, function ($array1, $array2) {
            return strlen($array2) <=> strlen($array1);
        });

        foreach ($keywords as $keyword) {
            $result = preg_match_all("/\b{$keyword}\b/", $message, $matches, PREG_OFFSET_CAPTURE);

            if ($result && !empty($matches[0])) {
                foreach ($matches[0] as $match) {
                    // check if the keyword does not overlap with one of the already found
                    if ($this->isPositionTaken($found, $match[1]) === false) {
                        $found[$keyword][] = $match[1];
                    }
                }
            }
        }

        return $found;
    }

    private function isPositionTaken(array $tokensPositions, $newPosition)
    {
        if (empty($tokensPositions)) {
            return false;
        }

        foreach ($tokensPositions as $token => $positions) {
            $tokenLength = strlen($token);
            foreach ($positions as $position) {
                if ($this->isPositionIn($newPosition, $position, $tokenLength) === true) {
                    return true;
                }
            }
        }

        return false;
    }

    private function isPositionIn($newPosition, $position, $tokenLength)
    {
        if ($newPosition >= $position && $newPosition < $position + $tokenLength) {

            return true;
        }

        return false;
    }
}


1		<?php
2
3		namespace Botonomous\utility;
4
5		use Botonomous\CommandContainer;
6
7		/**
8		* Class MessageUtility.
9		*/
10		class MessageUtility extends AbstractUtility
11		{
12		/**
13		* Remove the mentioned bot username from the message.
14		*
15		* @param $message
16		*
17		* @throws \Exception
18		*
19		* @return string
20		*/
21	9	public function removeMentionedBot($message)
22		{
23	9	$userLink = $this->getUserLink();
24
25	9	return preg_replace("/{$userLink}/", '', $message, 1);
26		}
27
28		/**
29		* Check if the bot user id is mentioned in the message.
30		*
31		* @param $message
32		*
33		* @throws \Exception
34		*
35		* @return bool
36		*/
37	2	public function isBotMentioned($message)
38		{
39	2	$userLink = $this->getUserLink();
40
41	2	return (new StringUtility())->findInString($userLink, $message, false);
42		}
43
44		/**
45		* Return command name in the message.
46		*
47		* @param $message
48		*
49		* @return null\|string
50		*/
51	8	public function extractCommandName($message)
52		{
53		// remove the bot mention if it exists
54	8	$message = $this->removeMentionedBot($message);
55
56		/**
57		* Command must start with / and at the beginning of the sentence.
58		*/
59	8	$commandPrefix = $this->getConfig()->get('commandPrefix');
60	8	$commandPrefix = preg_quote($commandPrefix, '/');
61
62	8	$pattern = '/^('.$commandPrefix.'\w{1,})/';
63
64	8	preg_match($pattern, ltrim($message), $groups);
65
66		// If command is found, remove command prefix from the beginning of the command
67	8	return isset($groups[1]) ? ltrim($groups[1], $commandPrefix) : null;
68		}
69
70		/**
71		* Return command details in the message.
72		*
73		* @param $message
74		*
75		* @return \Botonomous\Command\|null
76		*/
77	1	public function extractCommandDetails($message)
78		{
79		// first get the command name
80	1	$command = $this->extractCommandName($message);
81
82		// then get the command details
83	1	return (new CommandContainer())->getAsObject($command);
84		}
85
86		/**
87		* @param $triggerWord
88		* @param $message
89		*
90		* @return string
91		*/
92	4	public function removeTriggerWord($message, $triggerWord)
93		{
94	4	$count = 1;
95
96	4	return ltrim(str_replace($triggerWord, '', $message, $count));
97		}
98
99		/**
100		* @param $userId
101		* @param string $userName
102		*
103		* @throws \Exception
104		*
105		* @return string
106		*/
107	12	public function linkToUser($userId, $userName = '')
108		{
109	12	if (empty($userId)) {
110	1	throw new \Exception('User id is not provided');
111		}
112
113	12	if (!empty($userName)) {
114	1	$userName = "\|{$userName}";
115		}
116
117	12	return "<@{$userId}{$userName}>";
118		}
119
120		/**
121		* @return string
122		*/
123	11	private function getUserLink()
124		{
125	11	return $this->linkToUser($this->getConfig()->get('botUserId'));
126		}
127
128	2	public function keywordPos(array $keywords, $message)
129		{
130	2	$found = [];
131
132	2	if (empty($keywords)) {
133		return $found;
134		}
135
136	2	usort($keywords, function ($array1, $array2) {
137	2	return strlen($array2) <=> strlen($array1);
138	2	});
139
140	2	foreach ($keywords as $keyword) {
141	2	$result = preg_match_all("/\b{$keyword}\b/", $message, $matches, PREG_OFFSET_CAPTURE);
142
143	2	if ($result && !empty($matches[0])) {
144	2	foreach ($matches[0] as $match) {
145		// check if the keyword does not overlap with one of the already found
146	2	if ($this->isPositionTaken($found, $match[1]) === false) {
147	2	$found[$keyword][] = $match[1];
148		}
149		}
150		}
151		}
152
153	2	return $found;
154		}
155
156	2	private function isPositionTaken(array $tokensPositions, $newPosition)
157		{
158	2	if (empty($tokensPositions)) {
159	2	return false;
160		}
161
162	2	foreach ($tokensPositions as $token => $positions) {
163	2	$tokenLength = strlen($token);
164	2	foreach ($positions as $position) {
165	2	if ($this->isPositionIn($newPosition, $position, $tokenLength) === true) {
166	2	return true;
167		}
168		}
169		}
170
171	2	return false;
172		}
173
174	2	private function isPositionIn($newPosition, $position, $tokenLength)
175		{
176	2	if ($newPosition >= $position && $newPosition < $position + $tokenLength) {
		0 ignored issues – show Unused Code introduced 2017-07-17 13:24 UTC by Report Bug Copy Issue Report This `if` statement, and the following `return` statement can be replaced with `return $newPosition >= $...osition + $tokenLength;`. Loading history...
177	1	return true;
178		}
179
180	2	return false;
181		}
182		}
183

iranianpep / botonomous

Push — master ( c60756...531e59 )

MessageUtility::extractCommandName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like