User - Code Metrics - Inspection of "Fix broken calendar ical view rendering" - TechWilk/rota - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Christopher

created 2017-08-22 19:08 UTC

User B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	297
Duplicated Lines	14.14 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	42
loc	297
rs	8.2608
c	0
b	0
f	0
wmc	40
lcom	0
cbo	1

18 Methods

Rating	Name	Duplication	Size	Complexity
A	setPassword()	0	17	3
A	checkPassword()	0	10	2
A	isAdmin()	0	4	1
A	getName()	0	4	1
C	getProfileImage()	18	58	14
A	getCurrentRoles()	0	11	2
A	getUpcomingEvents()	0	4	1
A	getRolesInEvent()	0	4	1
A	getCurrentNotifications()	0	4	1
A	getUnreadNotifications()	0	4	1
A	isAvailableForEvent()	0	13	2
A	getAvailabilityForEvent()	0	7	1
A	getActiveCalendarTokens()	0	7	1
A	upcomingEventsAvailable()	12	12	1
A	upcomingEventsUnavailable()	12	12	1
B	upcomingEventsAwaitingResponse()	0	36	4
A	getInitials()	0	11	2
A	authoriser()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like User often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use User, and based on these observations, apply Extract Interface, too.

<?php

namespace TechWilk\Rota;

use DateTime;
use Propel\Runtime\ActiveQuery\Criteria;
use TechWilk\Rota\Authoriser\UserAuthoriser;
use TechWilk\Rota\Base\User as BaseUser;
use TechWilk\Rota\Map\UserTableMap;

/**
 * Skeleton subclass for representing a row from the 'cr_users' table.
 *
 *
 *
 * You should add additional methods to this class to meet the
 * application requirements.  This class will only be generated as
 * long as it does not already exist in the output directory.
 */
class User extends BaseUser
{
    /**
     * Set the value of [password] column.
     *
     * @param string $v new value
     *
     * @return $this|\User The current object (for fluent API support)
     */
    public function setPassword($v)
    {
        if ($v !== null) {
            $v = (string) $v;
        }

        if (!password_verify($v, $this->password)) {
            $bcrypt_options = [
        'cost' => 12,
      ];
            $this->password = password_hash($v, PASSWORD_BCRYPT, $bcrypt_options);

            $this->modifiedColumns[UserTableMap::COL_PASSWORD] = true;
        }

        return $this;
    }

    // setPassword()

    /**
     * Check a plain text password against the value of [password] column.
     *
     * @param string $v plain text password
     *
     * @return $this|\User The current object (for fluent API support)
     */
    public function checkPassword($v)
    {
        if ($v !== null) {
            $v = (string) $v;
        } else {
            return false;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return password_verify($v, $this->password);
    }

    // checkPassword()

    public function isAdmin()
    {
        return $this->isadmin;
    }

    /**
     * Get the [firstname] and [lastname] column value concatenated with a space.
     *
     * @return string
     */
    public function getName()
    {
        return $this->firstname.' '.$this->lastname;
    }

    /**
     * Get the URL for the user's profile image.
     *
     * @param string $size either 'small' or 'large'
     *
     * @return string
     */
    public function getProfileImage($size)
    {
        $socialAuths = $this->getSocialAuths();

        if (isset($socialAuths)) {
            foreach ($socialAuths as $socialAuth) {
                if ($socialAuth->getPlatform() == 'facebook') {
                    switch ($size) {
                        case 'small': // 50px x 50px
                            return '//graph.facebook.com/'.$socialAuth->getSocialId().'/picture?type=square';
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        case 'medium': // 200px x 200px
                            return '//graph.facebook.com/'.$socialAuth->getSocialId().'/picture?type=large';
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        case 'large': // 200px x 200px
                            return '//graph.facebook.com/'.$socialAuth->getSocialId().'/picture?type=large';
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        default:
                            return '//graph.facebook.com/'.$socialAuth->getSocialId().'/picture';
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                    }
                } elseif ($socialAuth->getPlatform() == 'onebody') {
                    $baseUrl = getConfig()['auth']['onebody']['url'];
                    $photoFingerprint = $socialAuth->getMeta()['photo-fingerprint'];
                    $extension = pathinfo($socialAuth->getMeta()['photo-file-name'], PATHINFO_EXTENSION);
                    switch ($size) {
                        case 'small': // 50px x 50px

                            return $baseUrl.'/system/production/people/photos/'.$socialAuth->getSocialId().'/tn/'.$photoFingerprint.'.'.$extension;
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        case 'medium': // 150px x 150px

                            return $baseUrl.'/system/production/people/photos/'.$socialAuth->getSocialId().'/small/'.$photoFingerprint.'.'.$extension;
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        case 'large': // 500px x 500px

                            return $baseUrl.'/system/production/people/photos/'.$socialAuth->getSocialId().'/medium/'.$photoFingerprint.'.'.$extension;
                            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                        default:

                            return $baseUrl.'/system/production/people/photos/'.$socialAuth->getSocialId().'/tn/'.$photoFingerprint.'.'.$extension;
                        break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                    }
                }
            }
        }

        switch ($size) {
            case 'small': // 50px x 50px

                return '//www.gravatar.com/avatar/'.md5(strtolower(trim($this->email))).'?s=50&d=mm';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'medium': // 200px x 200px
                return '//www.gravatar.com/avatar/'.md5(strtolower(trim($this->email))).'?s=200&d=mm';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case 'large': // 500px x 500px

                return '//www.gravatar.com/avatar/'.md5(strtolower(trim($this->email))).'?s=500&d=mm';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            default:
                return '//www.gravatar.com/avatar/'.md5(strtolower(trim($this->email))).'?s=50&d=mm';
            break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }

    /**
     * Get array of roles currently assigned to the user.
     *
     * @return array of Role() objects
     */
    public function getCurrentRoles()
    {
        $userRoles = $this->getUserRoles();

        $roles = [];
        foreach ($userRoles as $userRole) {
            $roles[] = $userRole->getRole();
        }

        return $roles;
    }

    /**
     * Get object of upcoming events currently assigned to the user.
     *
     * @return array of Event() objects
     */
    public function getUpcomingEvents()
    {
        return EventQuery::create()->filterByDate(['min' => new DateTime()])->useEventPersonQuery()->useUserRoleQuery()->filterByUser($this)->endUse()->endUse()->distinct()->find();
    }

    /**
     * Get object of upcoming events currently assigned to the user.
     *
     * @return array of Event() objects
     */
    public function getRolesInEvent(Event $event)
    {
        return RoleQuery::create()->useUserRoleQuery()->filterByUser($this)->useEventPersonQuery()->filterByEvent($event)->endUse()->endUse()->orderByName()->find();
    }

    public function getCurrentNotifications()
    {
        return NotificationQuery::create()->filterByUser($this)->filterByDismissed(false)->filterByArchived(false)->orderByTimestamp('desc')->find();
    }

    public function getUnreadNotifications()
    {
        return NotificationQuery::create()->filterBySeen(false)->filterByUser($this)->filterByDismissed(false)->filterByArchived(false)->orderByTimestamp('desc')->find();
    }

    /**
     * Determine if the user is marked as available for an event.
     *
     * @return bool if user is available
     */
    public function isAvailableForEvent(Event $event)
    {
        $availability = AvailabilityQuery::create()
            ->filterByUser($this)
            ->filterByEvent($event)
            ->findOne();

        if (is_null($availability)) {
            return;
        }

        return (bool) $availability->getAvailable();
    }

    /**
     * Determine if the user is marked as available for an event.
     *
     * @return \TechWilk\Rota\Availability
     */
    public function getAvailabilityForEvent(Event $event)
    {
        return AvailabilityQuery::create()
            ->filterByUser($this)
            ->filterByEvent($event)
            ->findOne();
    }

    public function getActiveCalendarTokens()
    {
        return CalendarTokenQuery::create()
            ->filterByUser($this)
            ->filterByRevoked(false)
            ->find();
    }

    public function upcomingEventsAvailable()

    {
        return EventQuery::create()
            ->useAvailabilityQuery()
                ->filterByUser($this)
                ->filterByAvailable(true)
            ->endUse()
            ->filterByRemoved(false)
            ->filterByDate(['min' => new DateTime()])
            ->orderByDate('asc')
            ->find();
    }

    public function upcomingEventsUnavailable()

    {
        return EventQuery::create()
            ->useAvailabilityQuery()
                ->filterByUser($this)
                ->filterByAvailable(false)
            ->endUse()
            ->filterByRemoved(false)
            ->filterByDate(['min' => new DateTime()])
            ->orderByDate('asc')
            ->find();
    }

    public function upcomingEventsAwaitingResponse()
    {
        $eventsWithResponse = EventQuery::create()
            ->useAvailabilityQuery()
                ->filterByUser($this)
            ->endUse()
            ->find();

        $eventsWithResponseArray = [];

        foreach ($eventsWithResponse as $event) {
            $eventsWithResponseArray[] = $event->getId();
        }

        $events = EventQuery::create()
            ->useAvailabilityQuery(null, Criteria::LEFT_JOIN)
                ->filterByUser($this, Criteria::NOT_EQUAL)
                ->_or()
                ->filterById(null)
            ->endUse()
            ->filterByRemoved(false)
            ->filterByDate(['min' => new DateTime()])
            ->orderByDate('asc')
            ->distinct()
            ->find();

        $eventsArray = [];

        foreach ($events as $event) {
            if (!in_array($event->getId(), $eventsWithResponseArray)) {
                $eventsArray[] = $event;
            }
        }

        return $eventsArray;
    }

    public function getInitials()
    {
        $names = str_replace('-', ' ', $this->getName());

        $names = explode(' ', $names);
        $initials = '';
        foreach ($names as $name) {
            $initials .= substr($name, 0, 1);
        }

        return $initials;
    }

    public function authoriser()
    {
        return new UserAuthoriser($this);
    }
}


TechWilk / rota