AdminStatsController::setUpAdminStats() - Code Metrics - Inspection of "Inc. test coverage of TopEdits; ignore coverage of..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( dad31f...0bbc99 )

by MusikAnimal
created 2018-03-29 02:49 UTC
AdminStatsController::setUpAdminStats() A

↳ Parent: AdminStatsController
Complexity

Conditions	2
Paths	2
Size

Total Lines	19
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
eloc	10
nc	2
nop	3
dl	0
loc	19
ccs	0
cts	0
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0
<?php

/**
 * This file contains the code that powers the AdminStats page of XTools.
 *
 * @version 1.5.1
 */

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\JsonResponse;
use Xtools\AdminStats;
use Xtools\AdminStatsRepository;
use Xtools\ProjectRepository;

/**
 * Class AdminStatsController
 *
 * @category AdminStats
 * @package  AppBundle\Controller
 * @author   XTools Team <[email protected]>
 * @license  GPL 3.0
 */
class AdminStatsController extends XtoolsController
{
    /** @var Project The project being queried. */
filter:
    dependency_paths: ["lib/*"]
    protected $project;

    /** @var AdminStats The admin stats instance that does all the work. */
    protected $adminStats;

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

    /**
     * Every action in this controller (other than 'index') calls this first.
     * If a response is returned, the calling action is expected to return it.
     * @param string $project
     * @param string $start
     * @param string $end
     * @return AdminStats|RedirectResponse
     * @codeCoverageIgnore
     */
    public function setUpAdminStats($project, $start = null, $end = null)
    {
        // Load the database information for the tool.
        // $projectData will be a redirect if the project is invalid.
        $projectData = $this->validateProject($project);
        if ($projectData instanceof RedirectResponse) {

            return $projectData;
        }
        $this->project = $projectData;


        list($start, $end) = $this->getUTCFromDateParams($start, $end);

        $this->adminStats = new AdminStats($this->project, $start, $end);
        $adminStatsRepo = new AdminStatsRepository();
        $adminStatsRepo->setContainer($this->container);
        $this->adminStats->setRepository($adminStatsRepo);

        // For testing purposes.
        return $this->adminStats;
    }

    /**
     * Method for rendering the AdminStats Main Form.
     * This method redirects if valid parameters are found, making it a
     * valid form endpoint as well.
     *
     * @param Request $request Generated by Symfony
     *
     * @Route("/adminstats",           name="adminstats")
     * @Route("/adminstats/",          name="AdminStatsSlash")
     * @Route("/adminstats/index.php", name="AdminStatsIndexPhp")
     *
     * @return Route|\Symfony\Component\HttpFoundation\Response
     */
    public function indexAction(Request $request)
    {
        $params = $this->parseQueryParams($request);

        // Redirect if we have a project. $results may also include start and/or end date.
        if (isset($params['project'])) {
            return $this->redirectToRoute('AdminStatsResult', $params);
        }

        // Otherwise render form.
        return $this->render('adminStats/index.html.twig', [
            'xtPage' => 'adminstats',
            'xtPageTitle' => 'tool-adminstats',
            'xtSubtitle' => 'tool-adminstats-desc',
        ]);
    }

    /**
     * Method for rendering the AdminStats Results
     *
     * @param Request $request The HTTP request.
     * @param string $project Project to run the results against
     * @param string $start   Date to start on.  Must parse by strtotime.
     * @param string $end     Date to end on.  Must parse by strtotime.
     *
     * @Route(
     *   "/adminstats/{project}/{start}/{end}", name="AdminStatsResult",
     *   requirements={"start" = "|\d{4}-\d{2}-\d{2}", "end" = "|\d{4}-\d{2}-\d{2}"}
     * )
     *
     * @return Route|\Symfony\Component\HttpFoundation\Response
     * @todo Move SQL to a model.
     * @codeCoverageIgnore
     */
    public function resultAction(Request $request, $project, $start = null, $end = null)
    public function resultAction(/** @scrutinizer ignore-unused */ Request $request, $project, $start = null, $end = null)
    {
        $ret = $this->setUpAdminStats($project, $start, $end);
        if ($ret instanceof RedirectResponse) {

            return $ret;
        }

        $this->adminStats->prepareStats();

        // Render the result!
        return $this->render('adminStats/result.html.twig', [
            'xtPage' => 'adminstats',
            'xtTitle' => $this->project->getDomain(),
            'project' => $this->project,
            'as' => $this->adminStats,
        ]);
    }

    /************************ API endpoints ************************/

    /**
     * Get users of the project that are capable of making 'admin actions',
     * keyed by user name with a list of the relevant user groups as the values.
     * @Route("/api/project/admins_groups/{project}", name="ProjectApiAdminsGroups")
     * @param string $project Project domain or database name.
     * @return Response
     * @codeCoverageIgnore
     */
    public function adminsGroupsApiAction($project)
    {
        $this->recordApiUsage('project/admins_groups');

        $ret = $this->setUpAdminStats($project);
        if ($ret instanceof RedirectResponse) {

            // FIXME: needs to render as JSON, fetching the message from the FlashBag.
            return $ret;
        }

        return new JsonResponse(
            $this->adminStats->getAdminsAndGroups(false),
            $this->adminStats->getAdminsAndGroups(/** @scrutinizer ignore-type */ false),
            Response::HTTP_OK
        );
    }

    /**
     * Get users of the project that are capable of making 'admin actions',
     * along with various stats about which actions they took. Time period is limited
     * to one month.
     * @Route("/api/project/adminstats/{project}/{days}", name="ProjectApiAdminStats")
     * @param string $project Project domain or database name.
     * @param int $days Number of days from present to grab data for. Maximum 30.
     * @return Response
     * @codeCoverageIgnore
     */
    public function adminStatsApiAction($project, $days = 30)
    {
        $this->recordApiUsage('project/adminstats');

        // Maximum 30 days.
        $days = min((int) $days, 30);
        $start = date('Y-m-d', strtotime("-$days days"));
        $end = date('Y-m-d');

        $ret = $this->setUpAdminStats($project, $start, $end);
        if ($ret instanceof RedirectResponse) {

            // FIXME: needs to render as JSON, fetching the message from the FlashBag.
            return $ret;
        }

        $this->adminStats->prepareStats(false);

        $response = [
            'project' => $this->project->getDomain(),
            'start' => $start,
            'end' => $end,
            'users' => $this->adminStats->getStats(false),
        ];

        return new JsonResponse(
            $response,
            Response::HTTP_OK
        );
    }
}

x-tools / xtools

Push — master ( dad31f...0bbc99 )

AdminStatsController::setUpAdminStats() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
