PluginTrait::getMatchers() - Code Metrics - nopolabs/yabot - Measure and Improve Code Quality continuously with Scrutinizer

PluginTrait::getMatchers() A
last analyzed 2019-03-15 16:33 UTC

↳ Parent: PluginTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Nopolabs\Yabot\Plugin;

use Exception;
use Nopolabs\Yabot\Helpers\ConfigTrait;
use Nopolabs\Yabot\Helpers\LogTrait;
use Nopolabs\Yabot\Message\Message;
use Throwable;

trait PluginTrait
{
    use LogTrait;
    use ConfigTrait;

    private $pluginId;

    /** @var PluginMatcher */
    private $pluginMatcher;

    /** @var MethodMatcher[] */
    private $methodMatchers;

    public function help(): string
    {
        return $this->get('help', 'no help available');
    }

    public function status(): string
    {
        return 'running';
    }

    public function init(string $pluginId, array $params)
    {
        $this->pluginId = $pluginId;
        $this->overrideConfig($params);
        $this->methodMatchers = $this->buildMethodMatchers($this->get('matchers'));
        $this->pluginMatcher = new PluginMatcher($pluginId, $this->getIsBot(), $this->getChannels(), $this->getUsers(), $this->getLog());

        $this->info("inited $pluginId config:", $this->getConfig());
    }

    public function replaceInPatterns($search, $replace, array $matchers): array
    {
        $replaced = [];
        foreach ($matchers as $name => $params) {
            $params['patterns'] = array_map(function($pattern) use ($search, $replace) {
                return str_replace($search, $replace, $pattern);
            }, $params['patterns']);
            $replaced[$name] = $params;
        }
        return $replaced;
    }

    public function getPriority(): int
    {
        return $this->get('priority');
    }

    public function getPrefix(): string
    {
        return $this->get('prefix');
    }

    public function handle(Message $message)
    {
        if (empty($this->pluginMatch($message))) {
            return;
        }

        $this->methodMatch($message);
    }

    protected function pluginMatch(Message $message): array
    {
        return $this->getPluginMatcher()->matches($message);
    }

    protected function getPluginMatcher() : PluginMatcher
    {
        return $this->pluginMatcher;
    }

    protected function methodMatch(Message $message)
    {
        foreach ($this->getMethodMatchers() as $methodMatcher) {
            /** @var MethodMatcher $methodMatcher */
            if ($matches = $methodMatcher->matches($message)) {
                $this->dispatchMatch($methodMatcher, $message, $matches);

                if ($message->isHandled()) {
                    return;
                }
            }
        }
    }

    protected function dispatchMatch(MethodMatcher $methodMatcher, Message $message, array $matches)
    {
        $method = $methodMatcher->getMethod();

        $this->info("dispatching {$this->pluginId}:{$methodMatcher->getName()}:$method ".json_encode($matches));

        $this->dispatch($method, $message, $matches);
    }

    protected function getMethodMatchers() : array
    {
        return $this->methodMatchers;
    }

    protected function dispatch(string $method, Message $message, array $matches)
    {
        if (!method_exists($this, $method)) {
            $this->warning("{$this->pluginId} no method named: $method");
            return;
        }

        try {

            $this->$method($message, $matches);

        } catch (Throwable $throwable) {
            $errmsg = 'Exception in '.static::class.'::'.$method."\n"
                .$throwable->getMessage()."\n"
                .$throwable->getTraceAsString();
            $this->warning($errmsg);
        }
    }

    protected function overrideConfig(array $params)
    {
        $config = $this->canonicalConfig(array_merge($this->getConfig(), $params));

        $this->setConfig($config);
    }

    protected function setPluginId($pluginId)
    {
        $this->pluginId = $pluginId;
    }

    protected function getUsers()
    {
        return $this->get('users');
    }

    protected function getChannels()
    {
        return $this->get('channels');
    }

    /**
     * @return bool|null
     */
    protected function getIsBot()
    {
        return $this->get('isBot');
    }

    protected function getMatchers(): array
    {
        return $this->get('matchers');
    }

    protected function canonicalConfig(array $config): array
    {
        $config['priority'] = $config['priority'] ?? PluginManager::DEFAULT_PRIORITY;
        $config['prefix'] = ($config['prefix'] ?? '') ? $config['prefix'] : PluginManager::NO_PREFIX;
        $config['isBot'] = $config['isBot'] ?? null;
        $config['channels'] = $config['channels'] ?? array_filter([$config['channel'] ?? null]);
        $config['users'] = $config['users'] ?? array_filter([$config['user'] ?? null]);
        $config['matchers'] = $this->canonicalMatchers($config['matchers'] ?? []);

        unset($config['channel']);
        unset($config['user']);

        return $config;
    }

    protected function canonicalMatchers(array $matchers): array
    {
        $expanded = [];

        foreach ($matchers as $name => $params) {
            $expanded[$name] = $this->canonicalMatcher($name, $params);
        }

        if (empty($expanded)) {
            $this->warning("{$this->pluginId} has no matchers");
        }

        return $expanded;
    }

    protected function canonicalMatcher(string $name, $params) : array
    {
        $params = is_array($params) ? $params : ['patterns' => [$params]];

        $method = $params['method'] ?? $name;

        if (!method_exists($this, $method)) {
            $this->warning("{$this->pluginId} no method named: $method");
        }

        $params['isBot'] = $params['isBot'] ?? null;
        $params['channels'] = $params['channels'] ?? array_filter([$params['channel'] ?? null]);
        $params['users'] = $params['users'] ?? array_filter([$params['user'] ?? null]);
        $params['patterns'] = $params['patterns'] ?? array_filter([$params['pattern'] ?? null]);
        $params['method'] = $method;

        unset($params['channel']);
        unset($params['user']);
        unset($params['pattern']);

        return $params;
    }

    protected function buildMethodMatchers(array $matchers) : array
    {
        $methodMatchers = [];

        foreach ($matchers as $name => $params) {
            $methodMatchers[] = new MethodMatcher(
                $name,
                $params['isBot'],
                $params['channels'],
                $params['users'],
                $this->validPatterns($params['patterns'], $name),
                $params['method'],
                $this->getLog()
            );
        }

        return $methodMatchers;
    }

    protected function validPatterns(array $patterns, $name) : array
    {
        $valid = [];
        foreach ($patterns as $pattern) {
            if ($this->isValidRegExp($pattern, $name)) {
                $valid[] = $pattern;
            }
        }
        return $valid;
    }

    protected function isValidRegExp($pattern, $name) : bool
    {
        try {
            preg_match($pattern, '');
            return true;
        } catch (Throwable $e) {
            $this->warning("$name.pattern='$pattern' ".$e->getMessage());
            return false;
        }
    }
}

1			<?php
2
3			namespace Nopolabs\Yabot\Plugin;
4
5			use Exception;
6			use Nopolabs\Yabot\Helpers\ConfigTrait;
7			use Nopolabs\Yabot\Helpers\LogTrait;
8			use Nopolabs\Yabot\Message\Message;
9			use Throwable;
10
11			trait PluginTrait
12			{
13			use LogTrait;
14			use ConfigTrait;
15
16			private $pluginId;
17
18			/** @var PluginMatcher */
19			private $pluginMatcher;
20
21			/** @var MethodMatcher[] */
22			private $methodMatchers;
23
24			public function help(): string
25			{
26			return $this->get('help', 'no help available');
27			}
28
29			public function status(): string
30			{
31			return 'running';
32			}
33
34			public function init(string $pluginId, array $params)
35			{
36			$this->pluginId = $pluginId;
37			$this->overrideConfig($params);
38			$this->methodMatchers = $this->buildMethodMatchers($this->get('matchers'));
39			$this->pluginMatcher = new PluginMatcher($pluginId, $this->getIsBot(), $this->getChannels(), $this->getUsers(), $this->getLog());
40
41			$this->info("inited $pluginId config:", $this->getConfig());
42			}
43
44			public function replaceInPatterns($search, $replace, array $matchers): array
45			{
46			$replaced = [];
47			foreach ($matchers as $name => $params) {
48			$params['patterns'] = array_map(function($pattern) use ($search, $replace) {
49			return str_replace($search, $replace, $pattern);
50			}, $params['patterns']);
51			$replaced[$name] = $params;
52			}
53			return $replaced;
54			}
55
56			public function getPriority(): int
57			{
58			return $this->get('priority');
59			}
60
61			public function getPrefix(): string
62			{
63			return $this->get('prefix');
64			}
65
66			public function handle(Message $message)
67			{
68			if (empty($this->pluginMatch($message))) {
69			return;
70			}
71
72			$this->methodMatch($message);
73			}
74
75			protected function pluginMatch(Message $message): array
76			{
77			return $this->getPluginMatcher()->matches($message);
78			}
79
80			protected function getPluginMatcher() : PluginMatcher
81			{
82			return $this->pluginMatcher;
83			}
84
85			protected function methodMatch(Message $message)
86			{
87			foreach ($this->getMethodMatchers() as $methodMatcher) {
88			/** @var MethodMatcher $methodMatcher */
89			if ($matches = $methodMatcher->matches($message)) {
90			$this->dispatchMatch($methodMatcher, $message, $matches);
91
92			if ($message->isHandled()) {
93			return;
94			}
95			}
96			}
97			}
98
99			protected function dispatchMatch(MethodMatcher $methodMatcher, Message $message, array $matches)
100			{
101			$method = $methodMatcher->getMethod();
102
103			$this->info("dispatching {$this->pluginId}:{$methodMatcher->getName()}:$method ".json_encode($matches));
104
105			$this->dispatch($method, $message, $matches);
106			}
107
108			protected function getMethodMatchers() : array
109			{
110			return $this->methodMatchers;
111			}
112
113			protected function dispatch(string $method, Message $message, array $matches)
114			{
115			if (!method_exists($this, $method)) {
116			$this->warning("{$this->pluginId} no method named: $method");
117			return;
118			}
119
120			try {
121
122			$this->$method($message, $matches);
123
124			} catch (Throwable $throwable) {
125			$errmsg = 'Exception in '.static::class.'::'.$method."\n"
126			.$throwable->getMessage()."\n"
127			.$throwable->getTraceAsString();
128			$this->warning($errmsg);
129			}
130			}
131
132			protected function overrideConfig(array $params)
133			{
134			$config = $this->canonicalConfig(array_merge($this->getConfig(), $params));
135
136			$this->setConfig($config);
137			}
138
139			protected function setPluginId($pluginId)
140			{
141			$this->pluginId = $pluginId;
142			}
143
144			protected function getUsers()
145			{
146			return $this->get('users');
147			}
148
149			protected function getChannels()
150			{
151			return $this->get('channels');
152			}
153
154			/**
155			* @return bool\|null
156			*/
157			protected function getIsBot()
158			{
159			return $this->get('isBot');
160			}
161
162			protected function getMatchers(): array
163			{
164			return $this->get('matchers');
165			}
166
167			protected function canonicalConfig(array $config): array
168			{
169			$config['priority'] = $config['priority'] ?? PluginManager::DEFAULT_PRIORITY;
170			$config['prefix'] = ($config['prefix'] ?? '') ? $config['prefix'] : PluginManager::NO_PREFIX;
171			$config['isBot'] = $config['isBot'] ?? null;
172			$config['channels'] = $config['channels'] ?? array_filter([$config['channel'] ?? null]);
173			$config['users'] = $config['users'] ?? array_filter([$config['user'] ?? null]);
174			$config['matchers'] = $this->canonicalMatchers($config['matchers'] ?? []);
175
176			unset($config['channel']);
177			unset($config['user']);
178
179			return $config;
180			}
181
182			protected function canonicalMatchers(array $matchers): array
183			{
184			$expanded = [];
185
186			foreach ($matchers as $name => $params) {
187			$expanded[$name] = $this->canonicalMatcher($name, $params);
188			}
189
190			if (empty($expanded)) {
191			$this->warning("{$this->pluginId} has no matchers");
192			}
193
194			return $expanded;
195			}
196
197			protected function canonicalMatcher(string $name, $params) : array
198			{
199			$params = is_array($params) ? $params : ['patterns' => [$params]];
200
201			$method = $params['method'] ?? $name;
202
203			if (!method_exists($this, $method)) {
204			$this->warning("{$this->pluginId} no method named: $method");
205			}
206
207			$params['isBot'] = $params['isBot'] ?? null;
208			$params['channels'] = $params['channels'] ?? array_filter([$params['channel'] ?? null]);
209			$params['users'] = $params['users'] ?? array_filter([$params['user'] ?? null]);
210			$params['patterns'] = $params['patterns'] ?? array_filter([$params['pattern'] ?? null]);
211			$params['method'] = $method;
212
213			unset($params['channel']);
214			unset($params['user']);
215			unset($params['pattern']);
216
217			return $params;
218			}
219
220			protected function buildMethodMatchers(array $matchers) : array
221			{
222			$methodMatchers = [];
223
224			foreach ($matchers as $name => $params) {
225			$methodMatchers[] = new MethodMatcher(
226			$name,
227			$params['isBot'],
228			$params['channels'],
229			$params['users'],
230			$this->validPatterns($params['patterns'], $name),
231			$params['method'],
232			$this->getLog()
233			);
234			}
235
236			return $methodMatchers;
237			}
238
239			protected function validPatterns(array $patterns, $name) : array
240			{
241			$valid = [];
242			foreach ($patterns as $pattern) {
243			if ($this->isValidRegExp($pattern, $name)) {
244			$valid[] = $pattern;
245			}
246			}
247			return $valid;
248			}
249
250			protected function isValidRegExp($pattern, $name) : bool
251			{
252			try {
253			preg_match($pattern, '');
254			return true;
255			} catch (Throwable $e) {
256			$this->warning("$name.pattern='$pattern' ".$e->getMessage());
257			return false;
258			}
259			}
260			}

nopolabs / yabot

PluginTrait::getMatchers() A last analyzed 2019-03-15 16:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PluginTrait::getMatchers() A
last analyzed 2019-03-15 16:33 UTC