ModifiedSince::getModifiedSince() - Code Metrics - Inspection of "Fix Composer Deprecations" - alexdebril/rss-atom-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#197)

unknown

created 2020-03-20 10:28 UTC

ModifiedSince::getModifiedSince() A

↳ Parent: ModifiedSince

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3.2098

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
ccs	5
cts	7
cp	0.7143
cc	3
nc	4
nop	1
crap	3.2098

<?php declare(strict_types=1);

namespace Debril\RssAtomBundle\Request;


use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

class ModifiedSince
{

    const HTTP_HEADER_NAME = 'If-Modified-Since';

    private $value;

    private $logger;

    public function __construct(RequestStack $requestStack, LoggerInterface $logger)
    {
        $this->logger = $logger;
        $this->value = $this->getModifiedSince($requestStack->getCurrentRequest());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @return \DateTime
     */
    public function getValue(): \DateTime
    {
        return $this->value;
    }

    private function getModifiedSince(Request $request):\DateTime
    {
        if ($request->headers->has(self::HTTP_HEADER_NAME)) {
            try {
                $string = $request->headers->get(self::HTTP_HEADER_NAME);
                return new \DateTime($string);
            } catch (\TypeError|\Exception $e) {
                $this->logger->notice(sprintf('If-Modified-Since Header has a unexpected value, exception was %s', $e->getMessage()));
            }
        }

        return new \DateTime('@1');
    }

}


1		<?php declare(strict_types=1);
2
3		namespace Debril\RssAtomBundle\Request;
4
5
6		use Psr\Log\LoggerInterface;
7		use Symfony\Component\HttpFoundation\Request;
8		use Symfony\Component\HttpFoundation\RequestStack;
9
10		class ModifiedSince
11		{
12
13		const HTTP_HEADER_NAME = 'If-Modified-Since';
14
15		private $value;
16
17		private $logger;
18
19	5	public function __construct(RequestStack $requestStack, LoggerInterface $logger)
20		{
21	5	$this->logger = $logger;
22	5	$this->value = $this->getModifiedSince($requestStack->getCurrentRequest());
		0 ignored issues – show Bug introduced 2019-08-09 13:48 UTC by Report Bug Copy Issue Report It seems like `$requestStack->getCurrentRequest()` can be `null`; however, `getModifiedSince()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
23	5	}
24
25		/**
26		* @return \DateTime
27		*/
28	4	public function getValue(): \DateTime
29		{
30	4	return $this->value;
31		}
32
33	5	private function getModifiedSince(Request $request):\DateTime
34		{
35	5	if ($request->headers->has(self::HTTP_HEADER_NAME)) {
36		try {
37	1	$string = $request->headers->get(self::HTTP_HEADER_NAME);
38	1	return new \DateTime($string);
39		} catch (\TypeError\|\Exception $e) {
40		$this->logger->notice(sprintf('If-Modified-Since Header has a unexpected value, exception was %s', $e->getMessage()));
41		}
42		}
43
44	5	return new \DateTime('@1');
45		}
46
47		}
48

alexdebril / rss-atom-bundle

Pull Request — master (#197)

ModifiedSince::getModifiedSince() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like