corpInfo::onMessage() - Code Metrics - Inspection of "Dev -> master" - shibdib/Dramiel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#106)

by Bob

created 2016-12-13 13:58 UTC

corpInfo::onMessage() B

↳ Parent: corpInfo

Complexity

Conditions	6
Paths	5

Size

Total Lines	52
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	34
nc	5
nop	2
dl	0
loc	52
rs	8.6868
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Robert Sardinia
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * @property  message
 */
class corpInfo
namespace YourVendor;

class YourClass { }
{
    public $config;
    public $discord;
    public $logger;
    private $excludeChannel;
    private $message;

    /**
     * @param $config
     * @param $discord
     * @param $logger
     */
    public function init($config, $discord, $logger)

    {
        $this->config = $config;
        $this->discord = $discord;
        $this->logger = $logger;
        $this->excludeChannel = $this->config['bot']['restrictedChannels'];
    }

    /**
     * @param $msgData
     * @param $message
     * @return null
     */
    public function onMessage($msgData, $message)
    {
        $channelID = (int) $msgData['message']['channelID'];

        if (in_array($channelID, $this->excludeChannel, true))
        {
            return null;
        }

        $this->message = $message;

        $message = $msgData['message']['message'];
        $user = $msgData['message']['from'];

        $data = command($message, $this->information()['trigger'], $this->config['bot']['trigger']);
        if (isset($data['trigger'])) {
            $messageString = $data['messageString'];
            $cleanString = urlencode($messageString);
            $corpID = corpID($cleanString);

            if (empty($corpID)) {
                return $this->message->reply('**Error:** Unable to find any group matching that name.');
            }

            $corporation = corpDetails($corpID);
            $corporationName = $corporation['corporation_name'];
            $allianceID = $corporation['alliance_id'];
            $allianceName = allianceName($allianceID);
            $ceoID = $corporation['ceo_id'];
            $ceoName = characterName($ceoID);
            $memberCount = $corporation['member_count'];
            $corpTicker = $corporation['ticker'];
            $url = "https://zkillboard.com/corporation/{$corpID}/";

            if ($corporationName === null || $corporationName === '') {
                return $this->message->reply('**Error:** No corporation found.');
            }


            $msg = "```Corp Name: {$corporationName}
Corp Ticker: {$corpTicker}
CEO: {$ceoName}
Alliance Name: {$allianceName}
Member Count: {$memberCount}
```
For more info, visit: $url";

            $this->logger->addInfo("corpInfo: Sending corp info to {$user}");
            $this->message->reply($msg);
        }
        return null;
    }

    /**
     * @return array
     */
    public function information()

    {
        return array(
            'name' => 'corp',
            'trigger' => array($this->config['bot']['trigger'] . 'corp'),
            'information' => 'Returns basic EVE Online data about a corporation from projectRena. To use simply type !corp corporation_name'
        );
    }
}


1		<?php
2		/**
3		* The MIT License (MIT)
4		*
5		* Copyright (c) 2016 Robert Sardinia
6		*
7		* Permission is hereby granted, free of charge, to any person obtaining a copy
8		* of this software and associated documentation files (the "Software"), to deal
9		* in the Software without restriction, including without limitation the rights
10		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11		* copies of the Software, and to permit persons to whom the Software is
12		* furnished to do so, subject to the following conditions:
13		*
14		* The above copyright notice and this permission notice shall be included in all
15		* copies or substantial portions of the Software.
16		*
17		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23		* SOFTWARE.
24		*/
25
26		/**
27		* @property message
28		*/
29		class corpInfo
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-16 19:16 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...
30		{
31		public $config;
32		public $discord;
33		public $logger;
34		private $excludeChannel;
35		private $message;
36
37		/**
38		* @param $config
39		* @param $discord
40		* @param $logger
41		*/
42	View Code Duplication	public function init($config, $discord, $logger)
		0 ignored issues – show Duplication introduced 2016-12-13 14:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
43		{
44		$this->config = $config;
45		$this->discord = $discord;
46		$this->logger = $logger;
47		$this->excludeChannel = $this->config['bot']['restrictedChannels'];
48		}
49
50		/**
51		* @param $msgData
52		* @param $message
53		* @return null
54		*/
55		public function onMessage($msgData, $message)
56		{
57		$channelID = (int) $msgData['message']['channelID'];
58
59		if (in_array($channelID, $this->excludeChannel, true))
60		{
61		return null;
62		}
63
64		$this->message = $message;
65
66		$message = $msgData['message']['message'];
67		$user = $msgData['message']['from'];
68
69		$data = command($message, $this->information()['trigger'], $this->config['bot']['trigger']);
70		if (isset($data['trigger'])) {
71		$messageString = $data['messageString'];
72		$cleanString = urlencode($messageString);
73		$corpID = corpID($cleanString);
74
75		if (empty($corpID)) {
76		return $this->message->reply('Error: Unable to find any group matching that name.');
77		}
78
79		$corporation = corpDetails($corpID);
80		$corporationName = $corporation['corporation_name'];
81		$allianceID = $corporation['alliance_id'];
82		$allianceName = allianceName($allianceID);
83		$ceoID = $corporation['ceo_id'];
84		$ceoName = characterName($ceoID);
85		$memberCount = $corporation['member_count'];
86		$corpTicker = $corporation['ticker'];
87		$url = "https://zkillboard.com/corporation/{$corpID}/";
88
89		if ($corporationName === null \|\| $corporationName === '') {
90		return $this->message->reply('Error: No corporation found.');
91		}
92
93
94		$msg = "```Corp Name: {$corporationName}
95		Corp Ticker: {$corpTicker}
96		CEO: {$ceoName}
97		Alliance Name: {$allianceName}
98		Member Count: {$memberCount}
99		```
100		For more info, visit: $url";
101
102		$this->logger->addInfo("corpInfo: Sending corp info to {$user}");
103		$this->message->reply($msg);
104		}
105		return null;
106		}
107
108		/**
109		* @return array
110		*/
111	View Code Duplication	public function information()
		0 ignored issues – show Duplication introduced 2016-07-16 19:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
112		{
113		return array(
114		'name' => 'corp',
115		'trigger' => array($this->config['bot']['trigger'] . 'corp'),
116		'information' => 'Returns basic EVE Online data about a corporation from projectRena. To use simply type !corp corporation_name'
117		);
118		}
119		}
120

shibdib / Dramiel

Pull Request — master (#106)

corpInfo::onMessage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like