CacheSubscriber::__construct() - Code Metrics - Inspection of "[Travis] Simplify matrix" - egeloen/ivory-http-adapter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#129)

by Eric

created 2017-01-13 20:48 UTC

CacheSubscriber::__construct() A

↳ Parent: CacheSubscriber

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php

/*
 * This file is part of the Ivory Http Adapter package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\HttpAdapter\Event\Subscriber;

use Ivory\HttpAdapter\Event\Cache\CacheInterface;
use Ivory\HttpAdapter\Event\Events;
use Ivory\HttpAdapter\Event\MultiRequestCreatedEvent;
use Ivory\HttpAdapter\Event\MultiRequestErroredEvent;
use Ivory\HttpAdapter\Event\MultiRequestSentEvent;
use Ivory\HttpAdapter\Event\RequestCreatedEvent;
use Ivory\HttpAdapter\Event\RequestErroredEvent;
use Ivory\HttpAdapter\Event\RequestSentEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

/**
 * Cache subscriber.
 *
 * @author GeLo <[email protected]>
 */
class CacheSubscriber implements EventSubscriberInterface
{
    /** @var \Ivory\HttpAdapter\Event\Cache\CacheInterface */
    private $cache;

    /**
     * Creates a cache subscriber.
     *
     * @param \Ivory\HttpAdapter\Event\Cache\CacheInterface $cache The cache
     */
    public function __construct(CacheInterface $cache)
    {
        $this->setCache($cache);
    }

    /**
     * Gets the cache.
     *
     * @return \Ivory\HttpAdapter\Event\Cache\CacheInterface The cache.
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * Sets the cache.
     *
     * @param \Ivory\HttpAdapter\Event\Cache\CacheInterface $cache The cache.
     */
    public function setCache(CacheInterface $cache)
    {
        $this->cache = $cache;
    }

    /**
     * On request created.
     *
     * @param \Ivory\HttpAdapter\Event\RequestCreatedEvent $event
     */
    public function onRequestCreated(RequestCreatedEvent $event)
    {
        $request = $event->getRequest();
        $messageFactory = $event->getHttpAdapter()->getConfiguration()->getMessageFactory();

        if (($response = $this->cache->getResponse($request, $messageFactory)) !== null) {
            $event->setResponse($response);
        } elseif (($exception = $this->cache->getException($request, $messageFactory)) !== null) {
            $event->setException($exception);
        }
    }

    /**
     * On request sent.
     *
     * @param \Ivory\HttpAdapter\Event\RequestSentEvent $event
     */
    public function onRequestSent(RequestSentEvent $event)
    {
        $this->cache->saveResponse($event->getResponse(), $event->getRequest());
/** @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);
    }
}
    }

    /**
     * On request errored.
     *
     * @param \Ivory\HttpAdapter\Event\RequestErroredEvent $event
     */
    public function onRequestErrored(RequestErroredEvent $event)
    {
        $this->cache->saveException($event->getException(), $event->getException()->getRequest());
/** @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);
    }
}
    }

    /**
     * On multi request created.
     *
     * @param \Ivory\HttpAdapter\Event\MultiRequestCreatedEvent $event
     */
    public function onMultiRequestCreated(MultiRequestCreatedEvent $event)
    {
        $messageFactory = $event->getHttpAdapter()->getConfiguration()->getMessageFactory();

        foreach ($event->getRequests() as $request) {
            if (($response = $this->cache->getResponse($request, $messageFactory)) !== null) {
                $event->addResponse($response);
                $event->removeRequest($request);
            } elseif (($exception = $this->cache->getException($request, $messageFactory)) !== null) {
                $event->addException($exception);
                $event->removeRequest($request);
            }
        }
    }

    /**
     * On multi request sent.
     *
     * @param \Ivory\HttpAdapter\Event\MultiRequestSentEvent $event
     */
    public function onMultiRequestSent(MultiRequestSentEvent $event)
    {
        foreach ($event->getResponses() as $response) {
            $this->cache->saveResponse($response, $response->getParameter('request'));
        }
    }

    /**
     * On multi request errored.
     *
     * @param \Ivory\HttpAdapter\Event\MultiRequestErroredEvent $event
     */
    public function onMultiRequestErrored(MultiRequestErroredEvent $event)
    {
        foreach ($event->getResponses() as $response) {
            $this->cache->saveResponse($response, $response->getParameter('request'));
        }

        foreach ($event->getExceptions() as $exception) {
            $this->cache->saveException($exception, $exception->getRequest());
/** @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);
    }
}
        }
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()

    {
        return [
            Events::REQUEST_CREATED       => ['onRequestCreated', -100],
            Events::REQUEST_SENT          => ['onRequestSent', -100],
            Events::REQUEST_ERRORED       => ['onRequestErrored', -100],
            Events::MULTI_REQUEST_CREATED => ['onMultiRequestCreated', -100],
            Events::MULTI_REQUEST_SENT    => ['onMultiRequestSent', -100],
            Events::MULTI_REQUEST_ERRORED => ['onMultiRequestErrored', -100],
        ];
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ivory Http Adapter package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Ivory\HttpAdapter\Event\Subscriber;
13
14			use Ivory\HttpAdapter\Event\Cache\CacheInterface;
15			use Ivory\HttpAdapter\Event\Events;
16			use Ivory\HttpAdapter\Event\MultiRequestCreatedEvent;
17			use Ivory\HttpAdapter\Event\MultiRequestErroredEvent;
18			use Ivory\HttpAdapter\Event\MultiRequestSentEvent;
19			use Ivory\HttpAdapter\Event\RequestCreatedEvent;
20			use Ivory\HttpAdapter\Event\RequestErroredEvent;
21			use Ivory\HttpAdapter\Event\RequestSentEvent;
22			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
23
24			/**
25			* Cache subscriber.
26			*
27			* @author GeLo <[email protected]>
28			*/
29			class CacheSubscriber implements EventSubscriberInterface
30			{
31			/** @var \Ivory\HttpAdapter\Event\Cache\CacheInterface */
32			private $cache;
33
34			/**
35			* Creates a cache subscriber.
36			*
37			* @param \Ivory\HttpAdapter\Event\Cache\CacheInterface $cache The cache
38			*/
39	228		public function __construct(CacheInterface $cache)
40			{
41	228		$this->setCache($cache);
42	228		}
43
44			/**
45			* Gets the cache.
46			*
47			* @return \Ivory\HttpAdapter\Event\Cache\CacheInterface The cache.
48			*/
49	19		public function getCache()
50			{
51	19		return $this->cache;
52			}
53
54			/**
55			* Sets the cache.
56			*
57			* @param \Ivory\HttpAdapter\Event\Cache\CacheInterface $cache The cache.
58			*/
59	228		public function setCache(CacheInterface $cache)
60			{
61	228		$this->cache = $cache;
62	228		}
63
64			/**
65			* On request created.
66			*
67			* @param \Ivory\HttpAdapter\Event\RequestCreatedEvent $event
68			*/
69	57		public function onRequestCreated(RequestCreatedEvent $event)
70			{
71	57		$request = $event->getRequest();
72	57		$messageFactory = $event->getHttpAdapter()->getConfiguration()->getMessageFactory();
73
74	57		if (($response = $this->cache->getResponse($request, $messageFactory)) !== null) {
75	19		$event->setResponse($response);
76	56		} elseif (($exception = $this->cache->getException($request, $messageFactory)) !== null) {
77	19		$event->setException($exception);
78	18		}
79	57		}
80
81			/**
82			* On request sent.
83			*
84			* @param \Ivory\HttpAdapter\Event\RequestSentEvent $event
85			*/
86	19		public function onRequestSent(RequestSentEvent $event)
87			{
88	19		$this->cache->saveResponse($event->getResponse(), $event->getRequest());
			0 ignored issues – show Bug introduced 2015-12-12 21:47 UTC by Report Bug Copy Issue Report It seems like `$event->getResponse()` can be `null`; however, `saveResponse()` 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...
89	19		}
90
91			/**
92			* On request errored.
93			*
94			* @param \Ivory\HttpAdapter\Event\RequestErroredEvent $event
95			*/
96	19		public function onRequestErrored(RequestErroredEvent $event)
97			{
98	19		$this->cache->saveException($event->getException(), $event->getException()->getRequest());
			0 ignored issues – show Bug introduced 2015-12-12 21:47 UTC by Report Bug Copy Issue Report It seems like `$event->getException()->getRequest()` can be `null`; however, `saveException()` 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...
99	19		}
100
101			/**
102			* On multi request created.
103			*
104			* @param \Ivory\HttpAdapter\Event\MultiRequestCreatedEvent $event
105			*/
106	57		public function onMultiRequestCreated(MultiRequestCreatedEvent $event)
107			{
108	57		$messageFactory = $event->getHttpAdapter()->getConfiguration()->getMessageFactory();
109
110	57		foreach ($event->getRequests() as $request) {
111	57		if (($response = $this->cache->getResponse($request, $messageFactory)) !== null) {
112	19		$event->addResponse($response);
113	19		$event->removeRequest($request);
114	56		} elseif (($exception = $this->cache->getException($request, $messageFactory)) !== null) {
115	19		$event->addException($exception);
116	21		$event->removeRequest($request);
117	18		}
118	54		}
119	57		}
120
121			/**
122			* On multi request sent.
123			*
124			* @param \Ivory\HttpAdapter\Event\MultiRequestSentEvent $event
125			*/
126	19		public function onMultiRequestSent(MultiRequestSentEvent $event)
127			{
128	19		foreach ($event->getResponses() as $response) {
129	19		$this->cache->saveResponse($response, $response->getParameter('request'));
130	18		}
131	19		}
132
133			/**
134			* On multi request errored.
135			*
136			* @param \Ivory\HttpAdapter\Event\MultiRequestErroredEvent $event
137			*/
138	19		public function onMultiRequestErrored(MultiRequestErroredEvent $event)
139			{
140	19		foreach ($event->getResponses() as $response) {
141	19		$this->cache->saveResponse($response, $response->getParameter('request'));
142	18		}
143
144	19		foreach ($event->getExceptions() as $exception) {
145	19		$this->cache->saveException($exception, $exception->getRequest());
			0 ignored issues – show Bug introduced 2015-12-12 21:47 UTC by Report Bug Copy Issue Report It seems like `$exception->getRequest()` can be `null`; however, `saveException()` 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...
146	18		}
147	19		}
148
149			/**
150			* {@inheritdoc}
151			*/
152	19	View Code Duplication	public static function getSubscribedEvents()
			0 ignored issues – show Duplication introduced 2015-12-12 21:47 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...
153			{
154			return [
155	19		Events::REQUEST_CREATED => ['onRequestCreated', -100],
156	18		Events::REQUEST_SENT => ['onRequestSent', -100],
157	18		Events::REQUEST_ERRORED => ['onRequestErrored', -100],
158	18		Events::MULTI_REQUEST_CREATED => ['onMultiRequestCreated', -100],
159	18		Events::MULTI_REQUEST_SENT => ['onMultiRequestSent', -100],
160	18		Events::MULTI_REQUEST_ERRORED => ['onMultiRequestErrored', -100],
161	18		];
162			}
163			}
164

egeloen / ivory-http-adapter

Pull Request — master (#129)

CacheSubscriber::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like