RfXVoteCalculatorController::resultAction() - Code Metrics - Inspection of "Merge pull request #67 from x-tools/rfa" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5c8e7a...62162d )

by MusikAnimal

created 2017-08-22 23:01 UTC

RfXVoteCalculatorController::resultAction() D

↳ Parent: RfXVoteCalculatorController

Complexity

Conditions	14
Paths	78

Size

Total Lines	131
Code Lines	84

Duplication

Lines	18
Ratio	13.74 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	18
loc	131
rs	4.9516
cc	14
eloc	84
nc	78
nop	2

How to fix Long Method Complexity

<?php
/**
 * This file contains the code that powers the RfX Vote Calculator page of XTools.
 */

namespace AppBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\CssSelector\Exception\InternalErrorException;
use Symfony\Component\Debug\Exception\ContextErrorException;
use Symfony\Component\HttpFoundation\Request;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Xtools\ProjectRepository;
use Xtools\PagesRepository;
use Xtools\RFX;
use Xtools\User;

/**
 * Controller for the RfX Vote Calculator.
 */
class RfXVoteCalculatorController extends Controller
{

    /**
     * Get the tool's shortname.
     *
     * @return string
     */
    public function getToolShortname()
    {
        return 'rfxvote';
    }

    /**
     * Renders the index page for RfXVoteCalculator
     *
     * @Route("/rfxvote", name="rfxvote")
     * @Route("/rfxvote", name="RfXVoteCalculator")
     *
     * @return Response
     */
    public function indexAction()
    {
        // Grab the request object, grab the values out of it.
        $request = Request::createFromGlobals();

        $projectQuery = $request->query->get('project');
        $username = $request->query->get('username');

        if ($projectQuery != '' && $username != '') {
            $routeParams = [ 'project' => $projectQuery, 'username' => $username ];
            return $this->redirectToRoute(
                'rfxvoteResult',
                $routeParams
            );
        } elseif ($projectQuery != '') {
            return $this->redirectToRoute(
                'rfxvoteResult',
                [
                    'project' => $projectQuery
                ]
            );
        }

        // Instantiate the project if we can, or use the default.
        $project = (!empty($projectQuery))
            ? ProjectRepository::getProject($projectQuery, $this->container)
            : ProjectRepository::getDefaultProject($this->container);

        return $this->render(
            'rfxVoteCalculator/index.html.twig',
            [
                'xtPageTitle' => 'tool-rfxvote',
                'xtSubtitle' => 'tool-rfxvote-desc',
                'xtPage' => 'rfxvote',
                'project' => $project,
            ]
        );
    }

    /**
     * Result View of RfXVoteCalculator
     *
     * @param string $project  The project we're working on
     * @param string $username Username of the user we're analysing.
     *
     * @Route("/rfxvote/{project}/{username}", name="rfxvoteResult")
     *
     * @return Response
     */
    public function resultAction($project, $username)
    {
        $conn = $this->getDoctrine()->getManager('replicas')->getConnection();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $projectData = ProjectRepository::getProject($project, $this->container);
        $projectRepo = $projectData->getRepository();
        $userData = new User($username);
        $pagesRepo = new PagesRepository();
        $pagesRepo->setContainer($this->container);


        $dbName = $projectData->getDatabaseName();

        $rfxParam = $this->getParameter('rfx');

        if (!$projectData->exists() || $rfxParam == null) {

            $this->addFlash('notice', ['invalid-project', $project]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return $this->redirectToRoute('rfxvote');
        }

        $namespaces = $projectData->getNamespaces();

        if (!isset($rfxParam[$projectData->getDomain()])) {
            $this->addFlash('notice', ['invalid-project-cant-use', $project]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return $this->redirectToRoute('rfxvote');
        }

        $pageTypes = $rfxParam[$projectData->getDomain()]['pages'];
        $namespace
            = $rfxParam[$projectData->getDomain()]['rfx_namespace'] !== null
            ? $rfxParam[$projectData->getDomain()]['rfx_namespace'] : 4;

        $finalData = [];

        // We should probably figure out a better way to do this...
        $ignoredPages = '';

        if (isset($rfxParam[$projectData->getDomain()]['excluded_title'])) {

            $titlesExcluded
                = $rfxParam[$projectData->getDomain()]['excluded_title'];
            foreach ($titlesExcluded as $ignoredPage) {
                $ignoredPages .= "AND p.page_title != \"$ignoredPage\"\r\n";
            }
        }

        if (isset($rfxParam[$projectData->getDomain()]['excluded_regex'])) {

            $titlesExcluded
                = $rfxParam[$projectData->getDomain()]['excluded_regex'];
            foreach ($titlesExcluded as $ignoredPage) {
                $ignoredPages .= "AND p.page_title NOT LIKE \"%$ignoredPage%\"\r\n";
            }
        }

        foreach ($pageTypes as $type) {
            $type = explode(':', $type, 2)[1];

            $type = str_replace(' ', '_', $type);

            $pageTable = $projectRepo->getTableName($dbName, 'page');
            $revisionTable
                = $projectRepo->getTableName($dbName, 'revision');

            $sql = "SELECT DISTINCT p.page_namespace, p.page_title
                    FROM $pageTable p
                    RIGHT JOIN $revisionTable r on p.page_id=r.rev_page
                    WHERE p.page_namespace = :namespace
                    AND r.rev_user_text = :username
                    And p.page_title LIKE \"$type/%\"
                    AND p.page_title NOT LIKE \"%$type/$username%\"
                    $ignoredPages";

            $sth = $conn->prepare($sql);
            $sth->bindParam('namespace', $namespace);
            $sth->bindParam('username', $username);

            $sth->execute();

            $titles = [];

            while ($row = $sth->fetch()) {
                $titles[] = $namespaces[$row['page_namespace']] .
                    ':' .$row['page_title'];
            }

            // Chunking... it's possible to make a URI too long
            $titleArray = array_chunk($titles, 20);

            foreach ($titleArray as $titlesWorked) {
                $pageData = $pagesRepo->getPagesWikitext($projectData, $titlesWorked);

                foreach ($pageData as $title => $text) {
                    $type = str_replace('_', ' ', $type);
                    $rfx = new RFX(
                        $text,
                        $rfxParam[$projectData->getDomain()]['sections'],
                        $namespaces[2],
                        $rfxParam[$projectData->getDomain()]['date_regexp'],
                        $username
                    );
                    $section = $rfx->getUserSectionFound();
                    if ($section == '') {
                        // Skip over ones where the user didn't !vote.
                        continue;
                    }
                    // Todo: i18n-ize this
                    $finalData[$type][$section][$title]['Support']
                        = sizeof($rfx->getSection('support'));
                    $finalData[$type][$section][$title]['Oppose']
                        = sizeof($rfx->getSection('oppose'));
                    $finalData[$type][$section][$title]['Neutral']
                        = sizeof($rfx->getSection('neutral'));
                    $finalData[$type][$section][$title]['Date']
                        = $rfx->getEndDate();
                    $finalData[$type][$section][$title]['name']
                        = explode('/', $title)[1];

                    unset($rfx);
                }
            }
        }

        return $this->render(
            'rfxVoteCalculator/result.html.twig',
            [
                'xtPage' => 'rfxvote',
                'xtTitle' => $username,
                'user' => $userData,
                'project' => $projectData,
                'data'=> $finalData,
            ]
        );
    }
}


1		<?php
2		/**
3		* This file contains the code that powers the RfX Vote Calculator page of XTools.
4		*/
5
6		namespace AppBundle\Controller;
7
8		use Symfony\Bundle\FrameworkBundle\Controller\Controller;
9		use Symfony\Component\CssSelector\Exception\InternalErrorException;
10		use Symfony\Component\Debug\Exception\ContextErrorException;
11		use Symfony\Component\HttpFoundation\Request;
12		use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
13		use Xtools\ProjectRepository;
14		use Xtools\PagesRepository;
15		use Xtools\RFX;
16		use Xtools\User;
17
18		/**
19		* Controller for the RfX Vote Calculator.
20		*/
21		class RfXVoteCalculatorController extends Controller
22		{
23
24		/**
25		* Get the tool's shortname.
26		*
27		* @return string
28		*/
29		public function getToolShortname()
30		{
31		return 'rfxvote';
32		}
33
34		/**
35		* Renders the index page for RfXVoteCalculator
36		*
37		* @Route("/rfxvote", name="rfxvote")
38		* @Route("/rfxvote", name="RfXVoteCalculator")
39		*
40		* @return Response
41		*/
42		public function indexAction()
43		{
44		// Grab the request object, grab the values out of it.
45		$request = Request::createFromGlobals();
46
47		$projectQuery = $request->query->get('project');
48		$username = $request->query->get('username');
49
50		if ($projectQuery != '' && $username != '') {
51		$routeParams = [ 'project' => $projectQuery, 'username' => $username ];
52		return $this->redirectToRoute(
53		'rfxvoteResult',
54		$routeParams
55		);
56		} elseif ($projectQuery != '') {
57		return $this->redirectToRoute(
58		'rfxvoteResult',
59		[
60		'project' => $projectQuery
61		]
62		);
63		}
64
65		// Instantiate the project if we can, or use the default.
66		$project = (!empty($projectQuery))
67		? ProjectRepository::getProject($projectQuery, $this->container)
68		: ProjectRepository::getDefaultProject($this->container);
69
70		return $this->render(
71		'rfxVoteCalculator/index.html.twig',
72		[
73		'xtPageTitle' => 'tool-rfxvote',
74		'xtSubtitle' => 'tool-rfxvote-desc',
75		'xtPage' => 'rfxvote',
76		'project' => $project,
77		]
78		);
79		}
80
81		/**
82		* Result View of RfXVoteCalculator
83		*
84		* @param string $project The project we're working on
85		* @param string $username Username of the user we're analysing.
86		*
87		* @Route("/rfxvote/{project}/{username}", name="rfxvoteResult")
88		*
89		* @return Response
90		*/
91		public function resultAction($project, $username)
92		{
93		$conn = $this->getDoctrine()->getManager('replicas')->getConnection();
		0 ignored issues – show Bug introduced 2017-04-11 20:27 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Doctrine\Common\Persistence\ObjectManager` as the method `getConnection()` does only exist in the following implementations of said interface: `Doctrine\ORM\Decorator\EntityManagerDecorator`, `Doctrine\ORM\EntityManager`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
94
95		$projectData = ProjectRepository::getProject($project, $this->container);
96		$projectRepo = $projectData->getRepository();
97		$userData = new User($username);
98		$pagesRepo = new PagesRepository();
99		$pagesRepo->setContainer($this->container);
		1 ignored issue – show Compatibility introduced 2017-08-22 22:01 UTC by Report Bug Copy Issue Report `$this->container` of type `object<Symfony\Component...ion\ContainerInterface>` is not a sub-type of `object<Symfony\Component...ncyInjection\Container>`. It seems like you assume a concrete implementation of the interface `Symfony\Component\Depend...tion\ContainerInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
100
101		$dbName = $projectData->getDatabaseName();
102
103		$rfxParam = $this->getParameter('rfx');
104
105	View Code Duplication	if (!$projectData->exists() \|\| $rfxParam == null) {
		0 ignored issues – show Duplication introduced 2017-07-25 02:18 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
106		$this->addFlash('notice', ['invalid-project', $project]);
		0 ignored issues – show Documentation introduced 2017-07-15 00:12 UTC by Report Bug Copy Issue Report `array('invalid-project', $project)` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
107		return $this->redirectToRoute('rfxvote');
108		}
109
110		$namespaces = $projectData->getNamespaces();
111
112		if (!isset($rfxParam[$projectData->getDomain()])) {
113		$this->addFlash('notice', ['invalid-project-cant-use', $project]);
		0 ignored issues – show Documentation introduced 2017-07-27 04:47 UTC by Report Bug Copy Issue Report `array('invalid-project-cant-use', $project)` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
114		return $this->redirectToRoute('rfxvote');
115		}
116
117		$pageTypes = $rfxParam[$projectData->getDomain()]['pages'];
118		$namespace
119		= $rfxParam[$projectData->getDomain()]['rfx_namespace'] !== null
120		? $rfxParam[$projectData->getDomain()]['rfx_namespace'] : 4;
121
122		$finalData = [];
123
124		// We should probably figure out a better way to do this...
125		$ignoredPages = '';
126
127	View Code Duplication	if (isset($rfxParam[$projectData->getDomain()]['excluded_title'])) {
		0 ignored issues – show Duplication introduced 2017-07-27 07:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
128		$titlesExcluded
129		= $rfxParam[$projectData->getDomain()]['excluded_title'];
130		foreach ($titlesExcluded as $ignoredPage) {
131		$ignoredPages .= "AND p.page_title != \"$ignoredPage\"\r\n";
132		}
133		}
134
135	View Code Duplication	if (isset($rfxParam[$projectData->getDomain()]['excluded_regex'])) {
		0 ignored issues – show Duplication introduced 2017-07-27 07:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
136		$titlesExcluded
137		= $rfxParam[$projectData->getDomain()]['excluded_regex'];
138		foreach ($titlesExcluded as $ignoredPage) {
139		$ignoredPages .= "AND p.page_title NOT LIKE \"%$ignoredPage%\"\r\n";
140		}
141		}
142
143		foreach ($pageTypes as $type) {
144		$type = explode(':', $type, 2)[1];
145
146		$type = str_replace(' ', '_', $type);
147
148		$pageTable = $projectRepo->getTableName($dbName, 'page');
149		$revisionTable
150		= $projectRepo->getTableName($dbName, 'revision');
151
152		$sql = "SELECT DISTINCT p.page_namespace, p.page_title
153		FROM $pageTable p
154		RIGHT JOIN $revisionTable r on p.page_id=r.rev_page
155		WHERE p.page_namespace = :namespace
156		AND r.rev_user_text = :username
157		And p.page_title LIKE \"$type/%\"
158		AND p.page_title NOT LIKE \"%$type/$username%\"
159		$ignoredPages";
160
161		$sth = $conn->prepare($sql);
162		$sth->bindParam('namespace', $namespace);
163		$sth->bindParam('username', $username);
164
165		$sth->execute();
166
167		$titles = [];
168
169		while ($row = $sth->fetch()) {
170		$titles[] = $namespaces[$row['page_namespace']] .
171		':' .$row['page_title'];
172		}
173
174		// Chunking... it's possible to make a URI too long
175		$titleArray = array_chunk($titles, 20);
176
177		foreach ($titleArray as $titlesWorked) {
178		$pageData = $pagesRepo->getPagesWikitext($projectData, $titlesWorked);
179
180		foreach ($pageData as $title => $text) {
181		$type = str_replace('_', ' ', $type);
182		$rfx = new RFX(
183		$text,
184		$rfxParam[$projectData->getDomain()]['sections'],
185		$namespaces[2],
186		$rfxParam[$projectData->getDomain()]['date_regexp'],
187		$username
188		);
189		$section = $rfx->getUserSectionFound();
190		if ($section == '') {
191		// Skip over ones where the user didn't !vote.
192		continue;
193		}
194		// Todo: i18n-ize this
195		$finalData[$type][$section][$title]['Support']
196		= sizeof($rfx->getSection('support'));
197		$finalData[$type][$section][$title]['Oppose']
198		= sizeof($rfx->getSection('oppose'));
199		$finalData[$type][$section][$title]['Neutral']
200		= sizeof($rfx->getSection('neutral'));
201		$finalData[$type][$section][$title]['Date']
202		= $rfx->getEndDate();
203		$finalData[$type][$section][$title]['name']
204		= explode('/', $title)[1];
205
206		unset($rfx);
207		}
208		}
209		}
210
211		return $this->render(
212		'rfxVoteCalculator/result.html.twig',
213		[
214		'xtPage' => 'rfxvote',
215		'xtTitle' => $username,
216		'user' => $userData,
217		'project' => $projectData,
218		'data'=> $finalData,
219		]
220		);
221		}
222		}
223

x-tools / xtools

Push — master ( 5c8e7a...62162d )

RfXVoteCalculatorController::resultAction() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like