AutoEdits::getOffset() - Code Metrics - Inspection of "New category edits tool to view a user's contribs..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 9c80d9...628b52 )

by MusikAnimal
created 2018-03-29 02:24 UTC
AutoEdits::getOffset() A

↳ Parent: AutoEdits
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php
/**
 * This file contains only the AutoEdits class.
 */

namespace Xtools;

/**
 * AutoEdits returns statistics about automated edits made by a user.
 */
class AutoEdits extends Model
{
    /** @var Project The project. */
    protected $project;

    /** @var User The user. */
    protected $user;

    /** @var int|string Which namespace we are querying for. */
    protected $namespace;

    /** @var string Start date. */
    protected $start;

    /** @var string End date. */
    protected $end;

    /** @var null|string The tool we're searching for when fetching (semi-)automated edits. */
    protected $tool;

    /** @var int Number of rows to OFFSET, used for pagination. */
    protected $offset;

    /** @var Edit[] The list of non-automated contributions. */
    protected $nonAutomatedEdits;

    /** @var Edit[] The list of automated contributions. */
    protected $automatedEdits;

    /** @var int Total number of edits. */
    protected $editCount;

    /** @var int Total number of non-automated edits. */
    protected $automatedCount;

    /** @var array Counts of known automated tools used by the given user. */
    protected $toolCounts;

    /** @var int Total number of edits made with the tools. */
    protected $toolsTotal;

    /**
     * Constructor for the AutoEdits class.
     * @param Project $project
     * @param User $user
     * @param int|string $namespace Namespace ID or 'all'
     * @param string $start Start date in a format accepted by strtotime()
     * @param string $end End date in a format accepted by strtotime()
     * @param string $tool The tool we're searching for when fetching (semi-)automated edits.
     * @param int $offset Used for pagination, offset results by N edits.
     */
    public function __construct(
        Project $project,
        User $user,
        $namespace = 'all',
        $start = '',
        $end = '',
        $tool = null,
        $offset = 0
    ) {
        $this->project = $project;
        $this->user = $user;
        $this->namespace = $namespace;
        $this->start = $start;
        $this->end = $end;
        $this->tool = $tool;
        $this->offset = $offset;
    }

    /**
     * Get the namespace.
     * @return int|string
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    /**
     * Get the start date.
     * @return string
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     * Get the end date.
     * @return string
     */
    public function getEnd()
    {
        return $this->end;
    }

    /**
     * The tool we're limiting the results to when fetching
     * (semi-)automated contributions.
     * @return null|string
     */
    public function getTool()
    {
        return $this->tool;
    }

    /**
     * Get the offset value.
     * @return int
     */
    public function getOffset()
    {
        return $this->offset;
    }

    /**
     * Get the raw edit count of the user.
     * @return int
     */
    public function getEditCount()
    {
        if (!is_int($this->editCount)) {

            $this->editCount = $this->user->countEdits(
                $this->project,
                $this->namespace,
                $this->start,
                $this->end
            );
        }

        return $this->editCount;
    }

    /**
     * Get the number of edits this user made using semi-automated tools.
     * This is not the same as self::getToolCounts because the regex can overlap.
     * @return int Result of query, see below.
     */
    public function getAutomatedCount()
    {
        if (is_int($this->automatedCount)) {

            return $this->automatedCount;
        }

        $this->automatedCount = (int)$this->getRepository()->countAutomatedEdits(
            $this->project,
            $this->user,
            $this->namespace,
            $this->start,
            $this->end
        );

        return $this->automatedCount;
    }

    /**
     * Get the percentage of all edits made using automated tools.
     * @return float
     */
    public function getAutomatedPercentage()
    {
        return $this->getEditCount() > 0
            ? ($this->getAutomatedCount() / $this->getEditCount()) * 100
            : 0;
    }

    /**
     * Get non-automated contributions for this user.
     * @param bool $raw Wether to return raw data from the database,
     *   or get Edit objects.
     * @return string[]|Edit[]
     */
    public function getNonAutomatedEdits($raw = false)
    {
        if (is_array($this->nonAutomatedEdits)) {

            return $this->nonAutomatedEdits;
        }

        $revs = $this->getRepository()->getNonAutomatedEdits(
            $this->project,
            $this->user,
            $this->namespace,
            $this->start,
            $this->end,
            $this->offset
        );

        if ($raw) {
            return $revs;
        }

        $this->nonAutomatedEdits = $this->getEditsFromRevs($revs);

        return $this->nonAutomatedEdits;
    }

    /**
     * Get automated contributions for this user.
     * @param bool $raw Wether to return raw data from the database,
     *   or get Edit objects.
     * @return Edit[]
     */
    public function getAutomatedEdits($raw = false)
    {
        if (is_array($this->automatedEdits)) {

            return $this->automatedEdits;
        }

        $revs = $this->getRepository()->getAutomatedEdits(
            $this->project,
            $this->user,
            $this->namespace,
            $this->start,
            $this->end,
            $this->tool,
            $this->offset
        );

        if ($raw) {
            return $revs;
        }

        $this->automatedEdits = $this->getEditsFromRevs($revs);

        return $this->automatedEdits;
    }

    /**
     * Transform database rows into Edit objects.
     * @param  string[] $revs
     * @return Edit[]
     */
    private function getEditsFromRevs(array $revs)
    {
        return array_map(function ($rev) {
            /* @var Page Page object to be passed to the Edit contructor. */
            $page = $this->getPageFromRev($rev);
            $rev['user'] = $this->user;

            return new Edit($page, $rev);
            return new Edit(/** @scrutinizer ignore-type */ $page, $rev);
        }, $revs);
    }

    /**
     * Get a Page object given a revision row.
     * @param array $rev Revision as retrieved from the database.
     * @return Page[]
     */
    private function getPageFromRev(array $rev)
    {
        $namespaces = $this->project->getNamespaces();
        $pageTitle = $rev['page_title'];
        $fullPageTitle = '';

        if ((int)$rev['page_namespace'] === 0) {
            $fullPageTitle = $pageTitle;
        } else {
            $fullPageTitle = $namespaces[$rev['page_namespace']].":$pageTitle";
        }

        return new Page($this->project, $fullPageTitle);
    }

    /**
     * Get counts of known automated tools used by the given user.
     * @return string[] Each tool that they used along with the count and link:
     *                  [
     *                      'Twinkle' => [
     *                          'count' => 50,
     *                          'link' => 'Wikipedia:Twinkle',
     *                      ],
     *                  ]
     */
    public function getToolCounts()
    {
        if (is_array($this->toolCounts)) {

            return $this->toolCounts;
        }

        $this->toolCounts = $this->getRepository()->getToolCounts(
            $this->project,
            $this->user,
            $this->namespace,
            $this->start,
            $this->end
        );

        return $this->toolCounts;
    }

    /**
     * Get the combined number of edits made with each tool. This is calculated
     * separately from self::getAutomatedCount() because the regex can sometimes
     * overlap, and the counts are actually different.
     * @return int
     */
    public function getToolsTotal()
    {
        if (!is_int($this->toolsTotal)) {

            $this->toolsTotal = array_reduce($this->getToolCounts(), function ($a, $b) {
                return $a + $b['count'];
            });
        }

        return $this->toolsTotal;
    }
}

x-tools / xtools

Push — master ( 9c80d9...628b52 )

AutoEdits::getOffset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
