GlobalContribs::globalEditCountsTopN() - Code Metrics - Inspection of "Pagination and limit refactor for contribution lis..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#406)

by MusikAnimal

created 2022-02-01 00:18 UTC

GlobalContribs::globalEditCountsTopN() A

↳ Parent: GlobalContribs

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
declare(strict_types = 1);

namespace AppBundle\Model;

use AppBundle\Repository\GlobalContribsRepository;

/**
 * A GlobalContribs provides a list of a user's edits to all projects.
 */
class GlobalContribs extends Model
{
    /** @var int Number of results per page. */
    public const PAGE_SIZE = 50;

    /** @var int[] Keys are project DB names. */
    protected $globalEditCounts;

    /** @var array Most recent revisions across all projects. */
    protected $globalEdits;

    /**
     * GlobalContribs constructor.
     * @param User $user
     * @param string|int|null $namespace Namespace ID or 'all'.
     * @param false|int $start As Unix timestamp.
     * @param false|int $end As Unix timestamp.
     * @param false|int $offset As Unix timestamp.
     * @param false|int $limit Number of results to return.
     */
    public function __construct(
        User $user,
        $namespace = 'all',
        $start = false,
        $end = false,
        $offset = false,
        $limit = self::PAGE_SIZE
    ) {
        $this->user = $user;
        $this->namespace = '' == $namespace ? 0 : $namespace;
        $this->start = $start;
        $this->end = $end;
        $this->offset = $offset;
        $this->limit = $limit;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Get the total edit counts for the top n projects of this user.
     * @param int $numProjects
     * @return mixed[] Each element has 'total' and 'project' keys.
     */
    public function globalEditCountsTopN(int $numProjects = 10): array
    {
        // Get counts.
        $editCounts = $this->globalEditCounts(true);
        // Truncate, and return.
        return array_slice($editCounts, 0, $numProjects);
    }

    /**
     * Get the total number of edits excluding the top n.
     * @param int $numProjects
     * @return int
     */
    public function globalEditCountWithoutTopN(int $numProjects = 10): int
    {
        $editCounts = $this->globalEditCounts(true);
        $bottomM = array_slice($editCounts, $numProjects);
        $total = 0;
        foreach ($bottomM as $editCount) {
            $total += $editCount['total'];
        }
        return $total;
    }

    /**
     * Get the grand total of all edits on all projects.
     * @return int
     */
    public function globalEditCount(): int
    {
        $total = 0;
        foreach ($this->globalEditCounts() as $editCount) {
            $total += $editCount['total'];
        }
        return $total;
    }

    /**
     * Get the total revision counts for all projects for this user.
     * @param bool $sorted Whether to sort the list by total, or not.
     * @return mixed[] Each element has 'total' and 'project' keys.
     */
    public function globalEditCounts(bool $sorted = false): array
    {
        if (empty($this->globalEditCounts)) {
            $this->globalEditCounts = $this->getRepository()
                ->globalEditCounts($this->user);
                ->/** @scrutinizer ignore-call */ globalEditCounts($this->user);
        }

        if ($sorted) {
            // Sort.
            uasort($this->globalEditCounts, function ($a, $b) {
                return $b['total'] - $a['total'];
            });
        }

        return $this->globalEditCounts;
    }

    public function numProjectsWithEdits(): int
    {
        return count($this->getRepository()->getProjectsWithEdits($this->user));
        return count($this->getRepository()->/** @scrutinizer ignore-call */ getProjectsWithEdits($this->user));
    }

    /**
     * Get the most recent revisions across all projects.
     * @return Edit[]
     */
    public function globalEdits(): array
    {
        if (is_array($this->globalEdits)) {

            return $this->globalEdits;
        }

        // Get projects with edits.
        $projects = $this->getRepository()->getProjectsWithEdits($this->user);
        if (0 === count($projects)) {
            return [];
        }

        // Get all revisions for those projects.
        /** @var GlobalContribsRepository $globalContribsRepo */
        $globalContribsRepo = $this->getRepository();
        $globalRevisionsData = $globalContribsRepo->getRevisions(
            array_keys($projects),
            $this->user,
            $this->namespace,
            $this->start,
            $this->end,
            $this->limit + 1,
            $this->offset
        );
        $globalEdits = [];

        foreach ($globalRevisionsData as $revision) {
            /** @var Project $project */
            $project = $projects[$revision['dbName']];

            // Can happen if the project is given from CentralAuth API but the database is not being replicated.
            if (null === $project) {
                continue;
            }

            $edit = $this->getEditFromRevision($project, $revision);
            $globalEdits[$edit->getTimestamp()->getTimestamp().'-'.$edit->getId()] = $edit;
        }

        // Sort and prune, before adding more.
        krsort($globalEdits);
        $this->globalEdits = array_slice($globalEdits, 0, $this->limit);

        return $this->globalEdits;
    }

    private function getEditFromRevision(Project $project, array $revision): Edit
    {
        $nsName = '';
        if ($revision['page_namespace']) {
            $nsName = $project->getNamespaces()[$revision['page_namespace']];
        }

        $page = $project->getRepository()
            ->getPage($project, ltrim($nsName.':'.$revision['page_title'], ':'));
            ->/** @scrutinizer ignore-call */ getPage($project, ltrim($nsName.':'.$revision['page_title'], ':'));
        return new Edit($page, $revision);
    }
}


x-tools / xtools

Pull Request — main (#406)

GlobalContribs::globalEditCountsTopN() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like