TopEdits::formatTopPages() - Code Metrics - Inspection of "TopEdits: Speed up by getting 'all' namespaces wit..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#106)

by MusikAnimal

created 2017-10-11 06:16 UTC

TopEdits::formatTopPages() B

↳ Parent: TopEdits

Complexity

Conditions	4
Paths	5

Size

Total Lines	27
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	14
nc	5
nop	1

<?php
/**
 * This file contains only the TopEdits class.
 */

namespace Xtools;

use Symfony\Component\DependencyInjection\Container;
use DateTime;

/**
 * TopEdits returns the top-edited pages by a user. There is not a separate
 * repository because there is only one query :)
 */
class TopEdits extends Model
{
    /** @var Project The project. */
    protected $project;

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

    /** @var string[] Top edits object for quick caching, keyed by namespace ID. */
    protected $topEdits = [];

    /** @var int Number of rows to fetch. */
    protected $limit;

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

    const DEFAULT_LIMIT_SINGLE_NAMESPACE = 100;
    const DEFAULT_LIMIT_ALL_NAMESPACES = 20;

    /**
     * TopEdits constructor.
     * @param Project $project
     * @param User $user
     * @param string|int Namespace ID or 'all'.
     * @param int $limit Number of rows to fetch. This defaults to
     *   DEFAULT_LIMIT_SINGLE_NAMESPACE if $this->namespace is a single namespace (int),
     *   and DEFAULT_LIMIT_ALL_NAMESPACES if $this->namespace is 'all'.
     */
    public function __construct(Project $project, User $user, $namespace = 0, $limit = null)
    {
        $this->project = $project;
        $this->user = $user;
        $this->namespace = $namespace === 'all' ? 'all' : (int)$namespace;
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;
}

        if ($limit) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $this->limit = $limit;
        } else {
            $this->limit = $this->namespace === 'all'
                ? self::DEFAULT_LIMIT_ALL_NAMESPACES
                : self::DEFAULT_LIMIT_SINGLE_NAMESPACE;
        }
    }

    /**
     * Get the limit set on number of rows to fetch.
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     * Get the namespace set on the instance.
     * @return int|string Namespace ID or 'all'.
     */
    public function getNamespace()
    {
        return $this->namespace;
    }

    /**
     * Get the top edits by a user in the given namespace, or 'all' namespaces.
     * This is the public function that should be used.
     * @return string[] Results of self::getTopEditsByNamespace(), keyed by namespace.
     */
    public function getTopEdits()
    {
        if (count($this->topEdits) > 0) {
            return $this->topEdits;
        }

        if ($this->namespace === 'all') {

            $pages = $this->getRepository()->getTopEditsAllNamespaces(
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
                $this->project,
                $this->user,
                $this->limit
            );
        } else {
            $pages = $this->getRepository()->getTopEditsNamespace(
                $this->project,
                $this->user,
                $this->namespace,
                $this->limit
            );
        }

        $this->topEdits = $this->formatTopPages($pages);
        return $this->topEdits;
    }

    /**
     * [formatTopPages description]
     * @param  string[] $pages As returned by TopEditsRepository::getTopEditsNamespace
     *                         or TopEditsRepository::getTopEditsAllNamespaces.
     * @return string[] Same as input but with 'displaytitle', and 'page_title_ns'.
     */
    private function formatTopPages($pages)
    {
        /** @var string[] The top edited pages, keyed by namespace ID. */
        $topEditedPages = [];

        /** @var string[] Display titles of the pages, which need to be fetched ahead of time. */
        $displayTitles = $this->getDisplayTitles($pages);

        foreach ($pages as $page) {
            $nsId = (int) $page['page_namespace'];
            $nsTitle = $nsId > 0 ? $this->project->getNamespaces()[$page['page_namespace']] . ':' : '';
            $pageTitle = $nsTitle . $page['page_title'];
            $page['displaytitle'] = $displayTitles[$pageTitle];

            // $page['page_title'] is retained without the namespace
            //  so we can link to TopEdits for that page.
            $page['page_title_ns'] = $pageTitle;

            if (isset($topEditedPages[$nsId])) {
                $topEditedPages[$nsId][] = $page;
            } else {
                $topEditedPages[$nsId] = [$page];
            }
        }

        return $topEditedPages;
    }

    /**
     * Get the display titles of the given pages.
     * @param  string[] $topPages As returned by $this->getRepository()->getTopEdits()
     * @return string[] Keys are the original supplied titles, and values are the display titles.
     */
    private function getDisplayTitles($topPages)
    {
        $namespaces = $this->project->getNamespaces();

        // First extract page titles including namespace.
        $pageTitles = array_map(function ($page) use ($namespaces) {
            // If non-mainspace, prepend namespace to the titles.
            $ns = $page['page_namespace'];
            $nsTitle = $ns > 0 ? $namespaces[$page['page_namespace']] . ':' : '';
            return $nsTitle . $page['page_title'];
        }, $topPages);

        return $this->getRepository()->getDisplayTitles($this->project, $pageTitles);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
    }
}


1			<?php
2			/**
3			* This file contains only the TopEdits class.
4			*/
5
6			namespace Xtools;
7
8			use Symfony\Component\DependencyInjection\Container;
9			use DateTime;
10
11			/**
12			* TopEdits returns the top-edited pages by a user. There is not a separate
13			* repository because there is only one query :)
14			*/
15			class TopEdits extends Model
16			{
17			/** @var Project The project. */
18			protected $project;
19
20			/** @var User The user. */
21			protected $user;
22
23			/** @var string[] Top edits object for quick caching, keyed by namespace ID. */
24			protected $topEdits = [];
25
26			/** @var int Number of rows to fetch. */
27			protected $limit;
28
29			/** @var int Which namespace we are querying for. */
30			protected $namespace;
31
32			const DEFAULT_LIMIT_SINGLE_NAMESPACE = 100;
33			const DEFAULT_LIMIT_ALL_NAMESPACES = 20;
34
35			/**
36			* TopEdits constructor.
37			* @param Project $project
38			* @param User $user
39			* @param string\|int Namespace ID or 'all'.
40			* @param int $limit Number of rows to fetch. This defaults to
41			* DEFAULT_LIMIT_SINGLE_NAMESPACE if $this->namespace is a single namespace (int),
42			* and DEFAULT_LIMIT_ALL_NAMESPACES if $this->namespace is 'all'.
43			*/
44			public function __construct(Project $project, User $user, $namespace = 0, $limit = null)
45			{
46			$this->project = $project;
47			$this->user = $user;
48			$this->namespace = $namespace === 'all' ? 'all' : (int)$namespace;
			0 ignored issues – show Documentation Bug introduced 2017-10-10 17:15 UTC by Report Bug Copy Issue Report It seems like `$namespace === 'all' ? 'all' : (int) $namespace` can also be of type `string`. However, the property `$namespace` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. 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; } Loading history... Unused Code Bug introduced 2017-10-10 16:55 UTC by Report Bug Copy Issue Report The strict comparison `===` seems to always evaluate to `false` as the types of `$namespace` (`integer`) and `'all'` (`string`) can never be identical. Maybe you want to use a loose comparison `==` instead? Loading history...
49
50			if ($limit) {
			0 ignored issues – show Bug Best Practice introduced 2017-10-10 16:55 UTC by Report Bug Copy Issue Report The expression `$limit` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
51			$this->limit = $limit;
52			} else {
53			$this->limit = $this->namespace === 'all'
54			? self::DEFAULT_LIMIT_ALL_NAMESPACES
55			: self::DEFAULT_LIMIT_SINGLE_NAMESPACE;
56			}
57			}
58
59			/**
60			* Get the limit set on number of rows to fetch.
61			* @return int
62			*/
63			public function getLimit()
64			{
65			return $this->limit;
66			}
67
68			/**
69			* Get the namespace set on the instance.
70			* @return int\|string Namespace ID or 'all'.
71			*/
72			public function getNamespace()
73			{
74			return $this->namespace;
75			}
76
77			/**
78			* Get the top edits by a user in the given namespace, or 'all' namespaces.
79			* This is the public function that should be used.
80			* @return string[] Results of self::getTopEditsByNamespace(), keyed by namespace.
81			*/
82			public function getTopEdits()
83			{
84			if (count($this->topEdits) > 0) {
85			return $this->topEdits;
86			}
87
88			if ($this->namespace === 'all') {
			0 ignored issues – show Unused Code Bug introduced 2017-10-11 05:09 UTC by Report Bug Copy Issue Report The strict comparison `===` seems to always evaluate to `false` as the types of `$this->namespace` (`integer`) and `'all'` (`string`) can never be identical. Maybe you want to use a loose comparison `==` instead? Loading history...
89			$pages = $this->getRepository()->getTopEditsAllNamespaces(
			1 ignored issue – show Bug introduced 2017-10-11 05:09 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getTopEditsAllNamespaces()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\TopEditsRepository`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
90			$this->project,
91			$this->user,
92			$this->limit
93			);
94			} else {
95			$pages = $this->getRepository()->getTopEditsNamespace(
96			$this->project,
97			$this->user,
98			$this->namespace,
99			$this->limit
100			);
101			}
102
103			$this->topEdits = $this->formatTopPages($pages);
104			return $this->topEdits;
105			}
106
107			/**
108			* [formatTopPages description]
109			* @param string[] $pages As returned by TopEditsRepository::getTopEditsNamespace
110			* or TopEditsRepository::getTopEditsAllNamespaces.
111			* @return string[] Same as input but with 'displaytitle', and 'page_title_ns'.
112			*/
113			private function formatTopPages($pages)
114			{
115			/** @var string[] The top edited pages, keyed by namespace ID. */
116			$topEditedPages = [];
117
118			/** @var string[] Display titles of the pages, which need to be fetched ahead of time. */
119			$displayTitles = $this->getDisplayTitles($pages);
120
121			foreach ($pages as $page) {
122			$nsId = (int) $page['page_namespace'];
123			$nsTitle = $nsId > 0 ? $this->project->getNamespaces()[$page['page_namespace']] . ':' : '';
124			$pageTitle = $nsTitle . $page['page_title'];
125			$page['displaytitle'] = $displayTitles[$pageTitle];
126
127			// $page['page_title'] is retained without the namespace
128			// so we can link to TopEdits for that page.
129			$page['page_title_ns'] = $pageTitle;
130
131			if (isset($topEditedPages[$nsId])) {
132			$topEditedPages[$nsId][] = $page;
133			} else {
134			$topEditedPages[$nsId] = [$page];
135			}
136			}
137
138			return $topEditedPages;
139			}
140
141			/**
142			* Get the display titles of the given pages.
143			* @param string[] $topPages As returned by $this->getRepository()->getTopEdits()
144			* @return string[] Keys are the original supplied titles, and values are the display titles.
145			*/
146			private function getDisplayTitles($topPages)
147			{
148			$namespaces = $this->project->getNamespaces();
149
150			// First extract page titles including namespace.
151			$pageTitles = array_map(function ($page) use ($namespaces) {
152			// If non-mainspace, prepend namespace to the titles.
153			$ns = $page['page_namespace'];
154			$nsTitle = $ns > 0 ? $namespaces[$page['page_namespace']] . ':' : '';
155			return $nsTitle . $page['page_title'];
156			}, $topPages);
157
158			return $this->getRepository()->getDisplayTitles($this->project, $pageTitles);
			1 ignored issue – show Bug introduced 2017-10-10 16:55 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getDisplayTitles()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\TopEditsRepository`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
159			}
160			}
161

x-tools / xtools

Pull Request — master (#106)

TopEdits::formatTopPages() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like