Botonomous\utility\MessageUtility

Complexity

Total Complexity

24

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

98%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	removeMentionedBot()	0	6	1
A	isBotMentioned()	0	6	1
A	extractCommandName()	0	18	2
A	extractCommandDetails()	0	8	1
A	removeTriggerWord()	0	6	1
A	linkToUser()	0	12	3
A	getUserLink()	0	4	1
C	keywordPos()	0	25	7
A	compareLength()	0	4	1
B	isPositionTaken()	0	17	6

<?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, [$this, 'compareLength']);

        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 compareLength($array1, $array2)
    {
        return strlen($array2) <=> strlen($array1);
    }

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

        foreach ($tokensPositions as $token => $positions) {
            $tokenLength = strlen($token);
            foreach ($positions as $position) {
                if ($newPosition >= $position && $newPosition < $position + $tokenLength) {
                    return true;
                }
            }
        }

        return false;
    }
}