AdminStats::groupAdminStatsByUsername() - Code Metrics - Inspection of "Merge pull request #113 from x-tools/adminstats-re..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd44b6...7febf5 )

by MusikAnimal

created 2017-10-16 19:58 UTC

AdminStats::groupAdminStatsByUsername() B

↳ Parent: AdminStats

Complexity

Conditions	4
Paths	4

Size

Total Lines	32
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	14
nc	4
nop	2

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

namespace Xtools;

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

/**
 * AdminStats returns information about users with administrative
 * rights on a given wiki.
 */
class AdminStats extends Model
{
    /** @var Project Project associated with this AdminStats instance. */
    protected $project;

    /** @var string[] Keyed by user name, values are arrays containing actions and counts. */
    protected $adminStats;

    /**
     * Keys are user names, values are their abbreviated user groups.
     * If abbreviations are turned on, this will instead be a string of the abbreviated
     * user groups, separated by slashes.
     * @var string[]|string
     */
    protected $adminsAndGroups;

    /** @var int Number of admins (sysops) who haven't made any actions within the time period. */
    protected $adminsWithoutActions = 0;

    /** @var int Number of actual admins (sysops), not users with admin-like actions. */
    protected $numSysops = 0;

    /** @var int Start of time period as UTC timestamp */
    protected $start;

    /** @var int End of time period as UTC timestamp */
    protected $end;

    /**
     * TopEdits constructor.
     * @param Project $project
     * @param int $start as UTC timestamp.
     * @param int $end as UTC timestamp.
     */
    public function __construct(Project $project, $start = null, $end = null)
    {
        $this->project = $project;
        $this->start = $start;
        $this->end = $end;
    }

    /**
     * Get users of the project that are capable of making 'admin actions',
     * keyed by user name with abbreviations for the user groups as the values.
     * @param  string $abbreviate If set, the keys of the result with be a string containing
     *   abbreviated versions of their user groups, such as 'A' instead of administrator,
     *   'CU' instead of CheckUser, etc. If $abbreviate is false, the keys of the result
     *   will be an array of the full-named user groups.
     * @see Project::getAdmins()
     * @return string[]
     */
    public function getAdminsAndGroups($abbreviate = true)
    {
        if ($this->adminsAndGroups) {
            return $this->adminsAndGroups;
        }

        /**
         * Each user group that is considered capable of making 'admin actions'.
         * @var string[]
         */
        $adminGroups = $this->getRepository()->getAdminGroups($this->project);
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.
    }
}

        /** @var array Keys are the usernames, values are thier user groups. */
        $admins = $this->project->getUsersInGroups($adminGroups);

        if ($abbreviate === false) {
            return $admins;
        }

        /**
         * Keys are the database-stored names, values are the abbreviations.
         * FIXME: i18n this somehow.
         * @var string[]
         */
        $userGroupAbbrMap = [
            'sysop' => 'A',
            'bureaucrat' => 'B',
            'steward' => 'S',
            'checkuser' => 'CU',
            'oversight' => 'OS',
            'bot' => 'Bot',
        ];

        foreach ($admins as $admin => $groups) {
            $abbrGroups = [];

            // Keep track of actual number of sysops.
            if (in_array('sysop', $groups)) {
                $this->numSysops++;
            }

            foreach ($groups as $group) {

                if (isset($userGroupAbbrMap[$group])) {
                    $abbrGroups[] = $userGroupAbbrMap[$group];
                }
            }

            // Make 'A' (admin) come before 'CU' (CheckUser), etc.
            sort($abbrGroups);

            $this->adminsAndGroups[$admin] = implode('/', $abbrGroups);
        }

        return $this->adminsAndGroups;
    }

    /**
     * The number of days we're spanning between the start and end date.
     * @return int
     */
    public function numDays()
    {
        return ($this->end - $this->start) / 60 / 60 / 24;
    }

    /**
     * Get the array of statistics for each qualifying user. This may be called
     * ahead of self::getStats() so certain class-level properties will be supplied
     * (such as self::numUsers(), which is called in the view before iterating
     * over the master array of statistics).
     * @param boolean $abbreviateGroups If set, the 'groups' list will be
     *   a string with abbreivated user groups names, as opposed to an array
     *   of full-named user groups.
     * @return string[]
     */
    public function prepareStats($abbreviateGroups = true)
    {
        if (isset($this->adminStats)) {
            return $this->adminStats;
        }

        // UTC to YYYYMMDDHHMMSS.
        $startDb = date('Ymd000000', $this->start);
        $endDb = date('Ymd235959', $this->end);

        $stats = $this->getRepository()->getStats($this->project, $startDb, $endDb);
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.
    }
}

        // Group by username.
        $stats = $this->groupAdminStatsByUsername($stats, $abbreviateGroups);

        $this->adminStats = $stats;

        return $this->adminStats;
    }

    /**
     * Get the master array of statistics for each qualifying user.
     * @param boolean $abbreviateGroups If set, the 'groups' list will be
     *   a string with abbreivated user groups names, as opposed to an array
     *   of full-named user groups.
     * @return string[]
     */
    public function getStats($abbreviateGroups = true)
    {
        if (isset($this->adminStats)) {
            $this->adminStats = $this->prepareStats($abbreviateGroups);

        }
        return $this->adminStats;
    }

    /**
     * Given the data returned by AdminStatsRepository::getStats,
     * return the stats keyed by user name, adding in a key/value for user groups.
     * @param  string[] $data As retrieved by AdminStatsRepository::getStats
     * @param boolean $abbreviateGroups If set, the 'groups' list will be
     *   a string with abbreivated user groups names, as opposed to an array
     *   of full-named user groups.
     * @return string[] Stats keyed by user name.
     * Functionality covered in test for self::getStats().
     * @codeCoverageIgnore
     */
    private function groupAdminStatsByUsername($data, $abbreviateGroups = true)
    {
        $adminsAndGroups = $this->getAdminsAndGroups($abbreviateGroups);
        $users = [];

        foreach ($data as $datum) {
            $username = $datum['user_name'];

            // Push to array containing all users with admin actions.
            // We also want numerical values to be integers.
            $users[$username] = array_map('intval', $datum);

            // Push back username which was casted to an integer.
            $users[$username]['user_name'] = $username;

            // Set the 'groups' property with the user groups they belong to (if any),
            // going off of self::getAdminsAndGroups().
            if (isset($adminsAndGroups[$username])) {
                $users[$username]['groups'] = $adminsAndGroups[$username];

                // Remove from actual admin list so later we can re-populate with zeros.
                unset($adminsAndGroups[$username]);
            } else {
                $users[$username]['groups'] = $abbreviateGroups ? '' : [];
            }
        }

        // Push any inactive admins back to $users with zero values.
        $users = $this->fillInactiveAdmins($users, $adminsAndGroups);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $users;
    }

    /**
     * Fill in inactive admins (no actions within time period), given the list of
     * remaining $adminsAndGroups from processing within self::groupAdminStatsByUsername().
     * @param  string[] $users As computed by self::groupAdminStatsByUsername().
     * @param  string[] $adminsAndGroups Remaining from self::getAdminsAndGroups().
     * @return string[]
     * @codeCoverageIgnore
     */
    private function fillInactiveAdmins($users, $adminsAndGroups)
    {
        foreach ($adminsAndGroups as $username => $groups) {
            $users[$username] = [
                'user_name' => $username,
                'delete' => 0,
                'restore' => 0,
                'block' => 0,
                'unblock' => 0,
                'protect' => 0,
                'unprotect' => 0,
                'rights' => 0,
                'import' => 0,
                'total' => 0,
                'groups' => $groups,
            ];
            $this->adminsWithoutActions++;
        }

        return $users;
    }

    /**
     * Get the formatted start date.
     * @return string
     */
    public function getStart()
    {
        return date('Y-m-d', $this->start);
    }

    /**
     * Get the formatted end date.
     * @return string
     */
    public function getEnd()
    {
        return date('Y-m-d', $this->end);
    }

    /**
     * Get the total number of admins (users currently with qualifying permissions).
     * @return int
     */
    public function numAdmins()
    {
        return $this->numSysops;
    }

    /**
     * Get the total number of users we're reporting as having made admin actions.
     * @return int
     */
    public function numUsers()
    {
        return count($this->adminStats);
    }

    /**
     * Number of admins who did make actions within the time period.
     * @return int
     */
    public function getNumAdminsWithActions()
    {
        return $this->numAdmins() - $this->adminsWithoutActions;
    }

    /**
     * Number of admins who did not make any actions within the time period.
     * @return int
     */
    public function getNumAdminsWithoutActions()
    {
        return $this->adminsWithoutActions;
    }
}


Push — master ( cd44b6...7febf5 )

AdminStats::groupAdminStatsByUsername() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* This file contains only the AdminStats class.
4			*/
5
6			namespace Xtools;
7
8			use Symfony\Component\DependencyInjection\Container;
9			use DateTime;
10
11			/**
12			* AdminStats returns information about users with administrative
13			* rights on a given wiki.
14			*/
15			class AdminStats extends Model
16			{
17			/** @var Project Project associated with this AdminStats instance. */
18			protected $project;
19
20			/** @var string[] Keyed by user name, values are arrays containing actions and counts. */
21			protected $adminStats;
22
23			/**
24			* Keys are user names, values are their abbreviated user groups.
25			* If abbreviations are turned on, this will instead be a string of the abbreviated
26			* user groups, separated by slashes.
27			* @var string[]\|string
28			*/
29			protected $adminsAndGroups;
30
31			/** @var int Number of admins (sysops) who haven't made any actions within the time period. */
32			protected $adminsWithoutActions = 0;
33
34			/** @var int Number of actual admins (sysops), not users with admin-like actions. */
35			protected $numSysops = 0;
36
37			/** @var int Start of time period as UTC timestamp */
38			protected $start;
39
40			/** @var int End of time period as UTC timestamp */
41			protected $end;
42
43			/**
44			* TopEdits constructor.
45			* @param Project $project
46			* @param int $start as UTC timestamp.
47			* @param int $end as UTC timestamp.
48			*/
49			public function __construct(Project $project, $start = null, $end = null)
50			{
51			$this->project = $project;
52			$this->start = $start;
53			$this->end = $end;
54			}
55
56			/**
57			* Get users of the project that are capable of making 'admin actions',
58			* keyed by user name with abbreviations for the user groups as the values.
59			* @param string $abbreviate If set, the keys of the result with be a string containing
60			* abbreviated versions of their user groups, such as 'A' instead of administrator,
61			* 'CU' instead of CheckUser, etc. If $abbreviate is false, the keys of the result
62			* will be an array of the full-named user groups.
63			* @see Project::getAdmins()
64			* @return string[]
65			*/
66			public function getAdminsAndGroups($abbreviate = true)
67			{
68			if ($this->adminsAndGroups) {
69			return $this->adminsAndGroups;
70			}
71
72			/**
73			* Each user group that is considered capable of making 'admin actions'.
74			* @var string[]
75			*/
76			$adminGroups = $this->getRepository()->getAdminGroups($this->project);
			1 ignored issue – show Bug introduced 2017-10-16 18:43 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 `getAdminGroups()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\AdminStatsRepository`. 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...
77
78			/** @var array Keys are the usernames, values are thier user groups. */
79			$admins = $this->project->getUsersInGroups($adminGroups);
80
81			if ($abbreviate === false) {
82			return $admins;
83			}
84
85			/**
86			* Keys are the database-stored names, values are the abbreviations.
87			* FIXME: i18n this somehow.
88			* @var string[]
89			*/
90			$userGroupAbbrMap = [
91			'sysop' => 'A',
92			'bureaucrat' => 'B',
93			'steward' => 'S',
94			'checkuser' => 'CU',
95			'oversight' => 'OS',
96			'bot' => 'Bot',
97			];
98
99			foreach ($admins as $admin => $groups) {
100			$abbrGroups = [];
101
102			// Keep track of actual number of sysops.
103			if (in_array('sysop', $groups)) {
104			$this->numSysops++;
105			}
106
107			foreach ($groups as $group) {
			0 ignored issues – show Bug introduced 2017-10-16 19:37 UTC by Report Bug Copy Issue Report The expression `$groups` of type `string` is not traversable. Loading history...
108			if (isset($userGroupAbbrMap[$group])) {
109			$abbrGroups[] = $userGroupAbbrMap[$group];
110			}
111			}
112
113			// Make 'A' (admin) come before 'CU' (CheckUser), etc.
114			sort($abbrGroups);
115
116			$this->adminsAndGroups[$admin] = implode('/', $abbrGroups);
117			}
118
119			return $this->adminsAndGroups;
120			}
121
122			/**
123			* The number of days we're spanning between the start and end date.
124			* @return int
125			*/
126			public function numDays()
127			{
128			return ($this->end - $this->start) / 60 / 60 / 24;
129			}
130
131			/**
132			* Get the array of statistics for each qualifying user. This may be called
133			* ahead of self::getStats() so certain class-level properties will be supplied
134			* (such as self::numUsers(), which is called in the view before iterating
135			* over the master array of statistics).
136			* @param boolean $abbreviateGroups If set, the 'groups' list will be
137			* a string with abbreivated user groups names, as opposed to an array
138			* of full-named user groups.
139			* @return string[]
140			*/
141			public function prepareStats($abbreviateGroups = true)
142			{
143			if (isset($this->adminStats)) {
144			return $this->adminStats;
145			}
146
147			// UTC to YYYYMMDDHHMMSS.
148			$startDb = date('Ymd000000', $this->start);
149			$endDb = date('Ymd235959', $this->end);
150
151			$stats = $this->getRepository()->getStats($this->project, $startDb, $endDb);
			1 ignored issue – show Bug introduced 2017-10-16 18:43 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 `getStats()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\AdminStatsRepository`. 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...
152
153			// Group by username.
154			$stats = $this->groupAdminStatsByUsername($stats, $abbreviateGroups);
155
156			$this->adminStats = $stats;
			0 ignored issues – show Documentation Bug introduced 2017-10-16 18:43 UTC by Report Bug Copy Issue Report It seems like `$stats` of type `array<integer,string\|arr...r","groups":"string"}>>` is incompatible with the declared type `array<integer,string>` of property `$adminStats`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
157			return $this->adminStats;
158			}
159
160			/**
161			* Get the master array of statistics for each qualifying user.
162			* @param boolean $abbreviateGroups If set, the 'groups' list will be
163			* a string with abbreivated user groups names, as opposed to an array
164			* of full-named user groups.
165			* @return string[]
166			*/
167			public function getStats($abbreviateGroups = true)
168			{
169			if (isset($this->adminStats)) {
170			$this->adminStats = $this->prepareStats($abbreviateGroups);
			0 ignored issues – show Documentation Bug introduced 2017-10-16 18:43 UTC by Report Bug Copy Issue Report It seems like `$this->prepareStats($abbreviateGroups)` of type `array<integer,string\|arr...r","groups":"string"}>>` is incompatible with the declared type `array<integer,string>` of property `$adminStats`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
171			}
172			return $this->adminStats;
173			}
174
175			/**
176			* Given the data returned by AdminStatsRepository::getStats,
177			* return the stats keyed by user name, adding in a key/value for user groups.
178			* @param string[] $data As retrieved by AdminStatsRepository::getStats
179			* @param boolean $abbreviateGroups If set, the 'groups' list will be
180			* a string with abbreivated user groups names, as opposed to an array
181			* of full-named user groups.
182			* @return string[] Stats keyed by user name.
183			* Functionality covered in test for self::getStats().
184			* @codeCoverageIgnore
185			*/
186			private function groupAdminStatsByUsername($data, $abbreviateGroups = true)
187			{
188			$adminsAndGroups = $this->getAdminsAndGroups($abbreviateGroups);
189			$users = [];
190
191			foreach ($data as $datum) {
192			$username = $datum['user_name'];
193
194			// Push to array containing all users with admin actions.
195			// We also want numerical values to be integers.
196			$users[$username] = array_map('intval', $datum);
197
198			// Push back username which was casted to an integer.
199			$users[$username]['user_name'] = $username;
200
201			// Set the 'groups' property with the user groups they belong to (if any),
202			// going off of self::getAdminsAndGroups().
203			if (isset($adminsAndGroups[$username])) {
204			$users[$username]['groups'] = $adminsAndGroups[$username];
205
206			// Remove from actual admin list so later we can re-populate with zeros.
207			unset($adminsAndGroups[$username]);
208			} else {
209			$users[$username]['groups'] = $abbreviateGroups ? '' : [];
210			}
211			}
212
213			// Push any inactive admins back to $users with zero values.
214			$users = $this->fillInactiveAdmins($users, $adminsAndGroups);
			0 ignored issues – show Bug introduced 2017-10-16 19:37 UTC by Report Bug Copy Issue Report It seems like `$adminsAndGroups` defined by `$this->getAdminsAndGroups($abbreviateGroups)` on line `188` can also be of type `string`; however, `Xtools\AdminStats::fillInactiveAdmins()` does only seem to accept `array<integer,string>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
215
216			return $users;
217			}
218
219			/**
220			* Fill in inactive admins (no actions within time period), given the list of
221			* remaining $adminsAndGroups from processing within self::groupAdminStatsByUsername().
222			* @param string[] $users As computed by self::groupAdminStatsByUsername().
223			* @param string[] $adminsAndGroups Remaining from self::getAdminsAndGroups().
224			* @return string[]
225			* @codeCoverageIgnore
226			*/
227			private function fillInactiveAdmins($users, $adminsAndGroups)
228			{
229			foreach ($adminsAndGroups as $username => $groups) {
230			$users[$username] = [
231			'user_name' => $username,
232			'delete' => 0,
233			'restore' => 0,
234			'block' => 0,
235			'unblock' => 0,
236			'protect' => 0,
237			'unprotect' => 0,
238			'rights' => 0,
239			'import' => 0,
240			'total' => 0,
241			'groups' => $groups,
242			];
243			$this->adminsWithoutActions++;
244			}
245
246			return $users;
247			}
248
249			/**
250			* Get the formatted start date.
251			* @return string
252			*/
253			public function getStart()
254			{
255			return date('Y-m-d', $this->start);
256			}
257
258			/**
259			* Get the formatted end date.
260			* @return string
261			*/
262			public function getEnd()
263			{
264			return date('Y-m-d', $this->end);
265			}
266
267			/**
268			* Get the total number of admins (users currently with qualifying permissions).
269			* @return int
270			*/
271			public function numAdmins()
272			{
273			return $this->numSysops;
274			}
275
276			/**
277			* Get the total number of users we're reporting as having made admin actions.
278			* @return int
279			*/
280			public function numUsers()
281			{
282			return count($this->adminStats);
283			}
284
285			/**
286			* Number of admins who did make actions within the time period.
287			* @return int
288			*/
289			public function getNumAdminsWithActions()
290			{
291			return $this->numAdmins() - $this->adminsWithoutActions;
292			}
293
294			/**
295			* Number of admins who did not make any actions within the time period.
296			* @return int
297			*/
298			public function getNumAdminsWithoutActions()
299			{
300			return $this->adminsWithoutActions;
301			}
302			}
303

x-tools / xtools

Push — master ( cd44b6...7febf5 )

AdminStats::groupAdminStatsByUsername() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like