DefaultController::__construct() - Code Metrics - Inspection of "Fix tests on AppVeyor" - alexislefebvre/AsyncTweetsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#107)

by Alexis

created 2020-10-30 23:09 UTC

DefaultController::__construct() A

↳ Parent: DefaultController

Complexity

Conditions	1
Paths	1

Size

Total Lines

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
nc	1
nop	1
crap	1

<?php

namespace AlexisLefebvre\Bundle\AsyncTweetsBundle\Controller;

use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\Tweet;
use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\TweetRepository;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController as BaseController;
use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\Session;

// Compatibility layer for Symfony 3.4
if (!class_exists('Symfony\Bundle\FrameworkBundle\Controller\Controller')) {
    class_alias('Symfony\Bundle\FrameworkBundle\Controller\Controller', 'Symfony\Bundle\FrameworkBundle\Controller\AbstractController');
}

class DefaultController extends BaseController
{
    /** @var EntityManagerInterface */
    private $entityManager;

    /** @var TweetRepository */
    private $tweetRepository;

    public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }

    public function indexAction(Request $request, ?int $firstTweetId): Response
    {
        /** @var TweetRepository $tweetRepository */
        $tweetRepository = $this->entityManager
            ->getRepository(Tweet::class);

        $this->tweetRepository = $tweetRepository;

        $tweets = $this->tweetRepository
            ->getWithUsersAndMedias($firstTweetId);

        $variables = $this->getVariables($request, $tweets, $firstTweetId);

        $response = $this->render(
            '@AsyncTweets/Default/index.html.twig',
            [
                'tweets' => $tweets,
                'vars'   => $variables,
            ]
        );

        if (!is_null($variables['cookie'])) {
            /** @var Cookie $cookie */
            $cookie = $variables['cookie'];
            $response->headers->setCookie($cookie);
        }

        return $response;
    }

    /**
     * @param array<Tweet> $tweets
     *
     * @return array<Cookie|int|string|null>
     */
    private function getVariables(Request $request, array $tweets, ?int $firstTweetId): array
    {
        $vars = [
            'first'    => $firstTweetId,
            'previous' => null,
            'next'     => null,
            'number'   => 0,
            'cookieId' => $this->getLastTweetIdFromCookie($request),
            // No cookie by default
            'cookie' => null,
        ];

        if (count($tweets) > 0) {
            $vars = $this->getTweetsVars($tweets, $vars);
        }

        return $vars;
    }

    /**
     * If a Tweet is displayed, fetch data from repository.
     *
     * @param array<Tweet>                  $tweets
     * @param array<Cookie|int|string|null> $vars
     *
     * @return array<Cookie|int|string|null>
     */
    private function getTweetsVars(array $tweets, array $vars): array
    {
        /** @var int $firstTweetId */
        $firstTweetId = $tweets[0]->getId();

        $vars['previous'] = $this->tweetRepository
            ->getPreviousTweetId($firstTweetId);
        $vars['next'] = $this->tweetRepository
            ->getNextTweetId($firstTweetId);

        // Only update the cookie if the last Tweet Id is bigger than
        //  the one in the cookie
        if ($firstTweetId > $vars['cookieId']) {
            $vars['cookie'] = $this->createCookie($firstTweetId);
            $vars['cookieId'] = $firstTweetId;
        }

        /** @var int */
        $cookieId = $vars['cookieId'];
        $vars['number'] = $this->tweetRepository
            ->countPendingTweets($cookieId);

        $vars['first'] = $firstTweetId;

        return $vars;
    }

    private function getLastTweetIdFromCookie(Request $request): ?int
    {
        if ($request->cookies->has('lastTweetId')) {
            return (int) $request->cookies->get('lastTweetId');
        }

        return null;
    }

    private function createCookie(int $firstTweetId): Cookie
    {
        $nextYear = new \DateTime('now');
        $nextYear->add(new \DateInterval('P1Y'));

        // Set last Tweet Id
        $cookie = new Cookie(
            'lastTweetId',
            (string) $firstTweetId,
            $nextYear->format('U')
        );

        return $cookie;
    }

    public function resetCookieAction(): RedirectResponse
    {
        /* @see http://www.craftitonline.com/2011/07/symfony2-how-to-set-a-cookie/ */
        $response = new RedirectResponse(
            $this->generateUrl('asynctweets_homepage')
        );

        // Reset last Tweet Id
        $cookie = new Cookie('lastTweetId', null);
        $response->headers->setCookie($cookie);

        return $response;
    }

    public function deleteLessThanAction(Request $request): RedirectResponse
    {
        $lastTweetId = $this->getLastTweetIdFromCookie($request);

        if (!is_null($lastTweetId)) {
            /** @var TweetRepository $tweetRepository */
            $tweetRepository = $this->entityManager
                ->getRepository(Tweet::class);

            $count = $tweetRepository
                ->deleteAndHideTweetsLessThanId($lastTweetId);

            /** @var Session<int> $session */

            $session = $this->get('session');

            $session->getFlashBag()->add(
                'message',
                sprintf('%s tweets deleted.', $count)
            );
        }

        return $this->redirect($this->generateUrl('asynctweets_homepage'));
    }
}


1		<?php
2
3		namespace AlexisLefebvre\Bundle\AsyncTweetsBundle\Controller;
4
5		use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\Tweet;
6		use AlexisLefebvre\Bundle\AsyncTweetsBundle\Entity\TweetRepository;
7		use Doctrine\ORM\EntityManagerInterface;
8		use Symfony\Bundle\FrameworkBundle\Controller\AbstractController as BaseController;
9		use Symfony\Component\HttpFoundation\Cookie;
10		use Symfony\Component\HttpFoundation\RedirectResponse;
11		use Symfony\Component\HttpFoundation\Request;
12		use Symfony\Component\HttpFoundation\Response;
13		use Symfony\Component\HttpFoundation\Session\Session;
14
15		// Compatibility layer for Symfony 3.4
16		if (!class_exists('Symfony\Bundle\FrameworkBundle\Controller\Controller')) {
17		class_alias('Symfony\Bundle\FrameworkBundle\Controller\Controller', 'Symfony\Bundle\FrameworkBundle\Controller\AbstractController');
18		}
19
20		class DefaultController extends BaseController
21		{
22		/** @var EntityManagerInterface */
23		private $entityManager;
24
25		/** @var TweetRepository */
26		private $tweetRepository;
27
28	7	public function __construct(EntityManagerInterface $entityManager)
29		{
30	7	$this->entityManager = $entityManager;
31	7	}
32
33	7	public function indexAction(Request $request, ?int $firstTweetId): Response
34		{
35		/** @var TweetRepository $tweetRepository */
36	7	$tweetRepository = $this->entityManager
37	7	->getRepository(Tweet::class);
38
39	7	$this->tweetRepository = $tweetRepository;
40
41	7	$tweets = $this->tweetRepository
42	7	->getWithUsersAndMedias($firstTweetId);
43
44	7	$variables = $this->getVariables($request, $tweets, $firstTweetId);
45
46	7	$response = $this->render(
47	7	'@AsyncTweets/Default/index.html.twig',
48		[
49	7	'tweets' => $tweets,
50	7	'vars' => $variables,
51		]
52		);
53
54	7	if (!is_null($variables['cookie'])) {
55		/** @var Cookie $cookie */
56	6	$cookie = $variables['cookie'];
57	6	$response->headers->setCookie($cookie);
58		}
59
60	7	return $response;
61		}
62
63		/**
64		* @param array<Tweet> $tweets
65		*
66		* @return array<Cookie\|int\|string\|null>
67		*/
68	7	private function getVariables(Request $request, array $tweets, ?int $firstTweetId): array
69		{
70		$vars = [
71	7	'first' => $firstTweetId,
72		'previous' => null,
73		'next' => null,
74	7	'number' => 0,
75	7	'cookieId' => $this->getLastTweetIdFromCookie($request),
76		// No cookie by default
77		'cookie' => null,
78		];
79
80	7	if (count($tweets) > 0) {
81	6	$vars = $this->getTweetsVars($tweets, $vars);
82		}
83
84	7	return $vars;
85		}
86
87		/**
88		* If a Tweet is displayed, fetch data from repository.
89		*
90		* @param array<Tweet> $tweets
91		* @param array<Cookie\|int\|string\|null> $vars
92		*
93		* @return array<Cookie\|int\|string\|null>
94		*/
95	6	private function getTweetsVars(array $tweets, array $vars): array
96		{
97		/** @var int $firstTweetId */
98	6	$firstTweetId = $tweets[0]->getId();
99
100	6	$vars['previous'] = $this->tweetRepository
101	6	->getPreviousTweetId($firstTweetId);
102	6	$vars['next'] = $this->tweetRepository
103	6	->getNextTweetId($firstTweetId);
104
105		// Only update the cookie if the last Tweet Id is bigger than
106		// the one in the cookie
107	6	if ($firstTweetId > $vars['cookieId']) {
108	6	$vars['cookie'] = $this->createCookie($firstTweetId);
109	6	$vars['cookieId'] = $firstTweetId;
110		}
111
112		/** @var int */
113	6	$cookieId = $vars['cookieId'];
114	6	$vars['number'] = $this->tweetRepository
115	6	->countPendingTweets($cookieId);
116
117	6	$vars['first'] = $firstTweetId;
118
119	6	return $vars;
120		}
121
122	7	private function getLastTweetIdFromCookie(Request $request): ?int
123		{
124	7	if ($request->cookies->has('lastTweetId')) {
125	4	return (int) $request->cookies->get('lastTweetId');
126		}
127
128	7	return null;
129		}
130
131	6	private function createCookie(int $firstTweetId): Cookie
132		{
133	6	$nextYear = new \DateTime('now');
134	6	$nextYear->add(new \DateInterval('P1Y'));
135
136		// Set last Tweet Id
137	6	$cookie = new Cookie(
138	6	'lastTweetId',
139	6	(string) $firstTweetId,
140	6	$nextYear->format('U')
141		);
142
143	6	return $cookie;
144		}
145
146	1	public function resetCookieAction(): RedirectResponse
147		{
148		/* @see http://www.craftitonline.com/2011/07/symfony2-how-to-set-a-cookie/ */
149	1	$response = new RedirectResponse(
150	1	$this->generateUrl('asynctweets_homepage')
151		);
152
153		// Reset last Tweet Id
154	1	$cookie = new Cookie('lastTweetId', null);
155	1	$response->headers->setCookie($cookie);
156
157	1	return $response;
158		}
159
160	2	public function deleteLessThanAction(Request $request): RedirectResponse
161		{
162	2	$lastTweetId = $this->getLastTweetIdFromCookie($request);
163
164	2	if (!is_null($lastTweetId)) {
165		/** @var TweetRepository $tweetRepository */
166	2	$tweetRepository = $this->entityManager
167	2	->getRepository(Tweet::class);
168
169		$count = $tweetRepository
170	2	->deleteAndHideTweetsLessThanId($lastTweetId);
171
172		/** @var Session<int> $session */
		0 ignored issues – show Documentation introduced 2020-07-11 19:43 UTC by Report Bug Copy Issue Report The doc-type `Session<int>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 7. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
173	2	$session = $this->get('session');
174
175	2	$session->getFlashBag()->add(
176	2	'message',
177	2	sprintf('%s tweets deleted.', $count)
178		);
179		}
180
181	2	return $this->redirect($this->generateUrl('asynctweets_homepage'));
182		}
183		}
184

alexislefebvre / AsyncTweetsBundle

Pull Request — master (#107)

DefaultController::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like