CliConfigReader::getBooleanOption() - Code Metrics - Inspection of "Feature/git checks before baseline" - DaveLiddament/sarb - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#75)

by Dave

created 2021-02-21 15:44 UTC

CliConfigReader::getBooleanOption() A

↳ Parent: CliConfigReader

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
c	0
b	0
f	0
nc	1
nop	2
dl	0
loc	6
rs	10

<?php

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Command\internal;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\SarbException;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\StreamableInputInterface;
use Webmozart\Assert\Assert;

class CliConfigReader
{
    public static function getArgument(InputInterface $input, string $argumentName): string
    {
        $value = $input->getArgument($argumentName);
        Assert::string($value);

        return $value;

    }

    public static function getOption(InputInterface $input, string $optionName): ?string
    {
        $value = $input->getOption($optionName);

        if (null === $value) {
            return null;
        }

        Assert::string($value);

        return $value;
    }

    public static function getOptionWithDefaultValue(InputInterface $input, string $optionName): string
    {
        $value = self::getOption($input, $optionName);
        Assert::notNull($value);

        return $value;

    }

    /**
     * Returns STDIN as a string.
     *
     * @throws SarbException
     */
    public static function getStdin(InputInterface $input): string
    {
        // If testing this will get input added by `CommandTester::setInputs` method.
        $inputSteam = ($input instanceof StreamableInputInterface) ? $input->getStream() : null;

        // If nothing from input stream use STDIN instead.
        $inputSteam = $inputSteam ?? \STDIN;

        $input = stream_get_contents($inputSteam);

        if (false === $input) {
            // No way of easily testing this
            throw new SarbException('Can not read input stream'); // @codeCoverageIgnore
        }

        return $input;
    }

    public static function getBooleanOption(InputInterface $input, string $argument): bool
    {
        $option = $input->getOption($argument);
        Assert::boolean($option);

        return $option;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace DaveLiddament\StaticAnalysisResultsBaseliner\Framework\Command\internal;
6
7			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\SarbException;
8			use Symfony\Component\Console\Input\InputInterface;
9			use Symfony\Component\Console\Input\StreamableInputInterface;
10			use Webmozart\Assert\Assert;
11
12			class CliConfigReader
13			{
14			public static function getArgument(InputInterface $input, string $argumentName): string
15			{
16			$value = $input->getArgument($argumentName);
17			Assert::string($value);
18
19			return $value;
			0 ignored issues – show Bug Best Practice introduced 2021-02-19 21:23 UTC by Report Bug Copy Issue Report The expression `return $value` could return the type `null\|string[]` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
20			}
21
22			public static function getOption(InputInterface $input, string $optionName): ?string
23			{
24			$value = $input->getOption($optionName);
25
26			if (null === $value) {
27			return null;
28			}
29
30			Assert::string($value);
31
32			return $value;
33			}
34
35			public static function getOptionWithDefaultValue(InputInterface $input, string $optionName): string
36			{
37			$value = self::getOption($input, $optionName);
38			Assert::notNull($value);
39
40			return $value;
			0 ignored issues – show Bug Best Practice introduced 2021-02-19 21:23 UTC by Report Bug Copy Issue Report The expression `return $value` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
41			}
42
43			/**
44			* Returns STDIN as a string.
45			*
46			* @throws SarbException
47			*/
48			public static function getStdin(InputInterface $input): string
49			{
50			// If testing this will get input added by `CommandTester::setInputs` method.
51			$inputSteam = ($input instanceof StreamableInputInterface) ? $input->getStream() : null;
52
53			// If nothing from input stream use STDIN instead.
54			$inputSteam = $inputSteam ?? \STDIN;
55
56			$input = stream_get_contents($inputSteam);
57
58			if (false === $input) {
59			// No way of easily testing this
60			throw new SarbException('Can not read input stream'); // @codeCoverageIgnore
61			}
62
63			return $input;
64			}
65
66			public static function getBooleanOption(InputInterface $input, string $argument): bool
67			{
68			$option = $input->getOption($argument);
69			Assert::boolean($option);
70
71			return $option;
72			}
73			}
74

DaveLiddament / sarb

Pull Request — master (#75)

CliConfigReader::getBooleanOption() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like