SignatureHandler::bindSignature() - Code Metrics - spatie/laravel-slack-slash-command - Measure and Improve Code Quality continuously with Scrutinizer

SignatureHandler::bindSignature() A
last analyzed 2020-10-12 09:04 UTC

↳ Parent: SignatureHandler

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	33
rs	9.392
c	0
b	0
f	0
cc	4
nc	8
nop	0

<?php

namespace Spatie\SlashCommand\Handlers;

use Illuminate\Console\Parser;
use Illuminate\Support\Str;
use Spatie\SlashCommand\Exceptions\InvalidHandler;
use Spatie\SlashCommand\Exceptions\InvalidInput;
use Spatie\SlashCommand\Request;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Helper\DescriptorHelper;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\StringInput;
use Symfony\Component\Console\Output\BufferedOutput;

abstract class SignatureHandler extends BaseHandler
{
    /** @var string */
    protected $name;

    /** @var string */
    protected $signature;

    /** @var string */
    protected $description;

    /** @var \Symfony\Component\Console\Input\StringInput */
    protected $input;

    /** @var \Symfony\Component\Console\Input\InputDefinition */
    protected $inputDefinition;

    /** @var bool */
    protected $signatureIsBound;

    public function __construct(Request $request)
    {
        parent::__construct($request);

        if (empty($this->signature)) {
            throw InvalidHandler::signatureIsRequired(static::class);
        }

        $this->signatureIsBound = $this->bindSignature($this->signature);

    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getSignature(): string
    {
        return $this->signature;
    }

    public function getDescription(): string
    {
        return $this->description ?: '';
    }

    /**
     * @param string $foo
     */
    public function getArgument($foo)
    {
        return $this->input->getArgument($foo);
    }

    public function getOption($foo)
    {
        return $this->input->getOption($foo);
    }

    public function getArguments(): array
    {
        return $this->input->getArguments();
    }

    public function getOptions(): array
    {
        return $this->input->getOptions();
    }

    /**
     * Get the full command (eg. `/bot ping`).
     *
     * @return string
     */
    public function getFullCommand(): string
    {
        return "/{$this->request->command} {$this->name}";
    }

    /**
     * Get the usage description, including parameters and options.
     *
     * @return string
     */
    public function getHelpDescription(): string
    {
        $inputDefinition = $this->inputDefinition;
        $output = new BufferedOutput();

        $name = $this->getFullCommand();

        $command = (new Command($name))
            ->setDefinition($inputDefinition)
            ->setDescription($this->getDescription());

        $descriptor = new DescriptorHelper();
        $descriptor->describe($output, $command);

        return $output->fetch();
    }

    public function canHandle(Request $request): bool
    {
        if (! $this->signatureIsBound) {
            return false;
        }

        $signatureParts = new SignatureParts($this->signature);

        if (! Str::is($signatureParts->getSlashCommandName(), $request->command)) {
            return false;
        }

        if (explode(' ', $request->text)[0] != $signatureParts->getHandlerName()) {
            return false;
        }

        return true;
    }

    protected function bindSignature()
    {
        $signatureParts = new SignatureParts($this->signature);

        $signature = $signatureParts->getSignatureWithoutCommandName();

        [$name, $arguments, $options] = Parser::parse($signature);


        $this->name = $name;

        $inputDefinition = new InputDefinition();

        foreach ($arguments as $argument) {
            $inputDefinition->addArgument($argument);
        }

        foreach ($options as $option) {
            $inputDefinition->addOption($option);
        }

        $inputWithoutHandlerName = explode(' ', $this->request->text, 2)[1] ?? '';

        $this->input = new StringInput($inputWithoutHandlerName);
        $this->inputDefinition = $inputDefinition;

        try {
            $this->input->bind($inputDefinition);
        } catch (RuntimeException $exception) {
            return false;
        }

        return true;
    }

    public function validate()
    {
        try {
            $this->input->validate();
        } catch (RuntimeException $exception) {
            throw new InvalidInput($exception->getMessage(), $this, $exception);
        }
    }
}


1			<?php
2
3			namespace Spatie\SlashCommand\Handlers;
4
5			use Illuminate\Console\Parser;
6			use Illuminate\Support\Str;
7			use Spatie\SlashCommand\Exceptions\InvalidHandler;
8			use Spatie\SlashCommand\Exceptions\InvalidInput;
9			use Spatie\SlashCommand\Request;
10			use Symfony\Component\Console\Command\Command;
11			use Symfony\Component\Console\Exception\RuntimeException;
12			use Symfony\Component\Console\Helper\DescriptorHelper;
13			use Symfony\Component\Console\Input\InputDefinition;
14			use Symfony\Component\Console\Input\StringInput;
15			use Symfony\Component\Console\Output\BufferedOutput;
16
17			abstract class SignatureHandler extends BaseHandler
18			{
19			/** @var string */
20			protected $name;
21
22			/** @var string */
23			protected $signature;
24
25			/** @var string */
26			protected $description;
27
28			/** @var \Symfony\Component\Console\Input\StringInput */
29			protected $input;
30
31			/** @var \Symfony\Component\Console\Input\InputDefinition */
32			protected $inputDefinition;
33
34			/** @var bool */
35			protected $signatureIsBound;
36
37			public function __construct(Request $request)
38			{
39			parent::__construct($request);
40
41			if (empty($this->signature)) {
42			throw InvalidHandler::signatureIsRequired(static::class);
43			}
44
45			$this->signatureIsBound = $this->bindSignature($this->signature);
			0 ignored issues – show Unused Code introduced 2016-07-21 19:37 UTC by Report Bug Copy Issue Report The call to `SignatureHandler::bindSignature()` has too many arguments starting with `$this->signature`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
46			}
47
48			public function getName(): string
49			{
50			return $this->name;
51			}
52
53			public function getSignature(): string
54			{
55			return $this->signature;
56			}
57
58			public function getDescription(): string
59			{
60			return $this->description ?: '';
61			}
62
63			/**
64			* @param string $foo
65			*/
66			public function getArgument($foo)
67			{
68			return $this->input->getArgument($foo);
69			}
70
71			public function getOption($foo)
72			{
73			return $this->input->getOption($foo);
74			}
75
76			public function getArguments(): array
77			{
78			return $this->input->getArguments();
79			}
80
81			public function getOptions(): array
82			{
83			return $this->input->getOptions();
84			}
85
86			/**
87			* Get the full command (eg. `/bot ping`).
88			*
89			* @return string
90			*/
91			public function getFullCommand(): string
92			{
93			return "/{$this->request->command} {$this->name}";
94			}
95
96			/**
97			* Get the usage description, including parameters and options.
98			*
99			* @return string
100			*/
101			public function getHelpDescription(): string
102			{
103			$inputDefinition = $this->inputDefinition;
104			$output = new BufferedOutput();
105
106			$name = $this->getFullCommand();
107
108			$command = (new Command($name))
109			->setDefinition($inputDefinition)
110			->setDescription($this->getDescription());
111
112			$descriptor = new DescriptorHelper();
113			$descriptor->describe($output, $command);
114
115			return $output->fetch();
116			}
117
118			public function canHandle(Request $request): bool
119			{
120			if (! $this->signatureIsBound) {
121			return false;
122			}
123
124			$signatureParts = new SignatureParts($this->signature);
125
126			if (! Str::is($signatureParts->getSlashCommandName(), $request->command)) {
127			return false;
128			}
129
130			if (explode(' ', $request->text)[0] != $signatureParts->getHandlerName()) {
131			return false;
132			}
133
134			return true;
135			}
136
137			protected function bindSignature()
138			{
139			$signatureParts = new SignatureParts($this->signature);
140
141			$signature = $signatureParts->getSignatureWithoutCommandName();
142
143			[$name, $arguments, $options] = Parser::parse($signature);
			0 ignored issues – show Bug introduced 2019-09-11 11:47 UTC by Report Bug Copy Issue Report The variable `$name` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-09-11 11:47 UTC by Report Bug Copy Issue Report The variable `$arguments` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-09-11 11:47 UTC by Report Bug Copy Issue Report The variable `$options` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
144
145			$this->name = $name;
146
147			$inputDefinition = new InputDefinition();
148
149			foreach ($arguments as $argument) {
150			$inputDefinition->addArgument($argument);
151			}
152
153			foreach ($options as $option) {
154			$inputDefinition->addOption($option);
155			}
156
157			$inputWithoutHandlerName = explode(' ', $this->request->text, 2)[1] ?? '';
158
159			$this->input = new StringInput($inputWithoutHandlerName);
160			$this->inputDefinition = $inputDefinition;
161
162			try {
163			$this->input->bind($inputDefinition);
164			} catch (RuntimeException $exception) {
165			return false;
166			}
167
168			return true;
169			}
170
171			public function validate()
172			{
173			try {
174			$this->input->validate();
175			} catch (RuntimeException $exception) {
176			throw new InvalidInput($exception->getMessage(), $this, $exception);
177			}
178			}
179			}
180

spatie / laravel-slack-slash-command

GitHub Access Token became invalid

SignatureHandler::bindSignature() A last analyzed 2020-10-12 09:04 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SignatureHandler::bindSignature() A
last analyzed 2020-10-12 09:04 UTC