CategoryEditsController::tooHighEditCountRoute() - Code Metrics - Inspection of "Rewrite to use dependency injection and extend Abs..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#442)

by MusikAnimal
created 2023-03-14 03:09 UTC
CategoryEditsController::tooHighEditCountRoute() A

↳ Parent: CategoryEditsController
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace App\Controller;

use App\Exception\XtoolsHttpException;
use App\Model\CategoryEdits;
use App\Repository\CategoryEditsRepository;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

/**
 * This controller serves the Category Edits tool.
 */
class CategoryEditsController extends XtoolsController
{
    protected CategoryEdits $categoryEdits;

    /** @var string[] The categories, with or without namespace. */
    protected array $categories;

    /** @var array Data that is passed to the view. */
    private array $output;

    /**
     * Get the name of the tool's index route.
     * This is also the name of the associated model.
     * @return string
     * @codeCoverageIgnore
     */
    public function getIndexRoute(): string
    {
        return 'CategoryEdits';
    }

    /**
     * Will redirect back to index if the user has too high of an edit count.
     * @return string
     */
    public function tooHighEditCountRoute(): string
    {
        return $this->getIndexRoute();
    }

    /**
     * Display the search form.
     * @Route("/categoryedits", name="CategoryEdits")
     * @Route("/categoryedits/{project}", name="CategoryEditsProject")
     * @return Response
     * @codeCoverageIgnore
     */
    public function indexAction(): Response
    {
        // Redirect if at minimum project, username and categories are provided.
        if (isset($this->params['project']) && isset($this->params['username']) && isset($this->params['categories'])) {
            return $this->redirectToRoute('CategoryEditsResult', $this->params);
        }

        return $this->render('categoryEdits/index.html.twig', array_merge([
            'xtPageTitle' => 'tool-categoryedits',
            'xtSubtitle' => 'tool-categoryedits-desc',
            'xtPage' => 'CategoryEdits',

            // Defaults that will get overridden if in $params.
            'namespace' => 0,
            'start' => '',
            'end' => '',
            'username' => '',
            'categories' => '',
        ], $this->params, ['project' => $this->project]));
    }

    /**
     * Set defaults, and instantiate the CategoryEdits model. This is called at the top of every view action.
     * @codeCoverageIgnore
     */
    private function setupCategoryEdits(CategoryEditsRepository $categoryEditsRepo): void
    {
        $this->extractCategories();

        $this->categoryEdits = new CategoryEdits(
            $categoryEditsRepo,
            $this->project,
            $this->user,
            /** @scrutinizer ignore-type */ $this->user,
            $this->categories,
            $this->start,
            $this->end,
            $this->offset
        );

        $this->output = [
            'xtPage' => 'CategoryEdits',
            'xtTitle' => $this->user->getUsername(),
            'xtTitle' => $this->user->/** @scrutinizer ignore-call */ getUsername(),
            'project' => $this->project,
            'user' => $this->user,
            'ce' => $this->categoryEdits,
            'is_sub_request' => $this->isSubRequest,
        ];
    }

    /**
     * Go through the categories and normalize values, and set them on class properties.
     * @codeCoverageIgnore
     */
    private function extractCategories(): void
    {
        // Split categories by pipe.
        $categories = explode('|', $this->request->get('categories'));
        $categories = explode('|', /** @scrutinizer ignore-type */ $this->request->get('categories'));

        // Loop through the given categories, stripping out the namespace.
        // If a namespace was removed, it is flagged it as normalize
        // We look for the wiki's category namespace name, and the MediaWiki default
        // 'Category:', which sometimes is used cross-wiki (because it still works).
        $normalized = false;
        $nsName = $this->project->getNamespaces()[14].':';
        $this->categories = array_map(function ($category) use ($nsName, &$normalized) {
            if (0 === strpos($category, $nsName) || 0 === strpos($category, 'Category:')) {
                $normalized = true;
            }
            return preg_replace('/^'.$nsName.'/', '', $category);
        }, $categories);

        // Redirect if normalized, since we don't want the Category: prefix in the URL.
        if ($normalized) {
            throw new XtoolsHttpException(
                '',
                $this->generateUrl($this->request->get('_route'), array_merge(
                $this->generateUrl(/** @scrutinizer ignore-type */ $this->request->get('_route'), array_merge(
                    $this->request->attributes->get('_route_params'),
                    ['categories' => implode('|', $this->categories)]
                ))
            );
        }
    }

    /**
     * Display the results.
     * @Route(
     *     "/categoryedits/{project}/{username}/{categories}/{start}/{end}/{offset}",
     *     name="CategoryEditsResult",
     *     requirements={
     *         "username" = "(ipr-.+\/\d+[^\/])|([^\/]+)",
     *         "categories"="(.+?)(?!\/(?:|\d{4}-\d{2}-\d{2})(?:\/(|\d{4}-\d{2}-\d{2}))?)?$",
     *         "start"="|\d{4}-\d{2}-\d{2}",
     *         "end"="|\d{4}-\d{2}-\d{2}",
     *         "offset"="|\d{4}-?\d{2}-?\d{2}T?\d{2}:?\d{2}:?\d{2}",
     *     },
     *     defaults={"start"=false, "end"=false, "offset"=false}
     * )
     * @param CategoryEditsRepository $categoryEditsRepo
     * @return Response
     * @codeCoverageIgnore
     */
    public function resultAction(CategoryEditsRepository $categoryEditsRepo): Response
    {
        $this->setupCategoryEdits($categoryEditsRepo);

        return $this->getFormattedResponse('categoryEdits/result', $this->output);
    }

    /**
     * Get edits by a user to pages in given categories.
     * @Route(
     *   "/categoryedits-contributions/{project}/{username}/{categories}/{start}/{end}/{offset}",
     *   name="CategoryContributionsResult",
     *   requirements={
     *       "username" = "(ipr-.+\/\d+[^\/])|([^\/]+)",
     *       "categories"="(.+?)(?!\/(?:|\d{4}-\d{2}-\d{2}))?",
     *       "start"="|\d{4}-\d{2}-\d{2}",
     *       "end"="|\d{4}-\d{2}-\d{2}",
     *       "offset"="|\d{4}-?\d{2}-?\d{2}T?\d{2}:?\d{2}:?\d{2}",
     *   },
     *   defaults={"start"=false, "end"=false, "offset"=false}
     * )
     * @param CategoryEditsRepository $categoryEditsRepo
     * @return Response
     * @codeCoverageIgnore
     */
    public function categoryContributionsAction(CategoryEditsRepository $categoryEditsRepo): Response
    {
        $this->setupCategoryEdits($categoryEditsRepo);

        return $this->render('categoryEdits/contributions.html.twig', $this->output);
    }

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

    /**
     * Count the number of category edits the given user has made.
     * @Route(
     *   "/api/user/category_editcount/{project}/{username}/{categories}/{start}/{end}",
     *   name="UserApiCategoryEditCount",
     *   requirements={
     *       "username" = "(ipr-.+\/\d+[^\/])|([^\/]+)",
     *       "categories" = "(.+?)(?!\/(?:|\d{4}-\d{2}-\d{2})(?:\/(|\d{4}-\d{2}-\d{2}))?)?$",
     *       "start" = "|\d{4}-\d{2}-\d{2}",
     *       "end" = "|\d{4}-\d{2}-\d{2}"
     *   },
     *   defaults={"start" = false, "end" = false}
     * )
     * @param CategoryEditsRepository $categoryEditsRepo
     * @return JsonResponse
     * @codeCoverageIgnore
     */
    public function categoryEditCountApiAction(CategoryEditsRepository $categoryEditsRepo): JsonResponse
    {
        $this->recordApiUsage('user/category_editcount');

        $this->setupCategoryEdits($categoryEditsRepo);

        $ret = [
            'total_editcount' => $this->categoryEdits->getEditCount(),
            'category_editcount' => $this->categoryEdits->getCategoryEditCount(),
        ];

        return $this->getFormattedApiResponse($ret);
    }
}

x-tools / xtools

Pull Request — main (#442)

CategoryEditsController::tooHighEditCountRoute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
