TwitterCoordinatesSerializer::canUnserialize() - Code Metrics - Inspection of "changed serialization" - remi-san/twitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8bcfe7...12792b )

by Rémi

created 2016-05-11 21:46 UTC

TwitterCoordinatesSerializer::canUnserialize() A

↳ Parent: TwitterCoordinatesSerializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Twitter\Serializer;

use Twitter\Object\TwitterCoordinates;
use Twitter\TwitterSerializable;
use Twitter\TwitterSerializer;

class TwitterCoordinatesSerializer implements TwitterSerializer
{
    /**
     * @param  TwitterSerializable $object
     * @return \stdClass
     */
    public function serialize(TwitterSerializable $object)
    {
        if (!$this->canSerialize($object)) {
            throw new \InvalidArgumentException('$object must be an instance of TwitterCoordinates');
        }

        $coords = new \stdClass();
        $coords->coordinates = [$object->getLongitude(), $object->getLatitude()];
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
        $coords->type = $object->getType();
interface User
{
    /** @return string */
    public function getPassword();
}

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

        return $coords;
    }

    /**
     * @param  \stdClass $obj
     * @param  array $context
     * @return TwitterCoordinates
     */
    public function unserialize($obj, array $context = [])
    {
        if (!$this->canUnserialize($obj)) {
            throw new \InvalidArgumentException('$object is not unserializable');
        }

        $coords = $obj->coordinates;

        return TwitterCoordinates::create($coords[0], $coords[1], $obj->type);
    }

    /**
     * @param  TwitterSerializable $object
     * @return boolean
     */
    public function canSerialize(TwitterSerializable $object)
    {
        return $object instanceof TwitterCoordinates;
    }

    /**
     * @param  \stdClass $object
     * @return boolean
     */
    public function canUnserialize($object)
    {
        return isset($object->coordinates);
    }

    /**
     * @return TwitterCoordinatesSerializer
     */
    public static function build()
    {
        return new self();
    }
}


1		<?php
2
3		namespace Twitter\Serializer;
4
5		use Twitter\Object\TwitterCoordinates;
6		use Twitter\TwitterSerializable;
7		use Twitter\TwitterSerializer;
8
9		class TwitterCoordinatesSerializer implements TwitterSerializer
10		{
11		/**
12		* @param TwitterSerializable $object
13		* @return \stdClass
14		*/
15	6	public function serialize(TwitterSerializable $object)
16		{
17	6	if (!$this->canSerialize($object)) {
18	3	throw new \InvalidArgumentException('$object must be an instance of TwitterCoordinates');
19		}
20
21	3	$coords = new \stdClass();
22	3	$coords->coordinates = [$object->getLongitude(), $object->getLatitude()];
		0 ignored issues – show Bug introduced 2016-05-11 21:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twitter\TwitterSerializable` as the method `getLongitude()` does only exist in the following implementations of said interface: `Twitter\Object\TwitterCoordinates`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string / public function getDisplayName(); } Loading history... Bug introduced 2016-05-11 21:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twitter\TwitterSerializable` as the method `getLatitude()` does only exist in the following implementations of said interface: `Twitter\Object\TwitterCoordinates`. Let’s take a look at an example: interface User { /* @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
23	3	$coords->type = $object->getType();
		0 ignored issues – show Bug introduced 2016-05-11 21:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twitter\TwitterSerializable` as the method `getType()` does only exist in the following implementations of said interface: `Twitter\Object\AbstractTwitterMedia`, `Twitter\Object\TwitterCoordinates`, `Twitter\Object\TwitterDelete`, `Twitter\Object\TwitterEvent`, `Twitter\Object\TwitterExtendedEntity`, `Twitter\Object\TwitterMedia`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
24
25	3	return $coords;
26		}
27
28		/**
29		* @param \stdClass $obj
30		* @param array $context
31		* @return TwitterCoordinates
32		*/
33	3	public function unserialize($obj, array $context = [])
34		{
35	3	if (!$this->canUnserialize($obj)) {
36		throw new \InvalidArgumentException('$object is not unserializable');
37	3	}
38
39		$coords = $obj->coordinates;
40
41		return TwitterCoordinates::create($coords[0], $coords[1], $obj->type);
42		}
43	15
44		/**
45	15	* @param TwitterSerializable $object
46		* @return boolean
47		*/
48		public function canSerialize(TwitterSerializable $object)
49		{
50		return $object instanceof TwitterCoordinates;
51		}
52
53		/**
54		* @param \stdClass $object
55		* @return boolean
56		*/
57		public function canUnserialize($object)
58		{
59		return isset($object->coordinates);
60		}
61
62		/**
63		* @return TwitterCoordinatesSerializer
64		*/
65		public static function build()
66		{
67		return new self();
68		}
69		}
70

remi-san / twitter

Push — master ( 8bcfe7...12792b )

TwitterCoordinatesSerializer::canUnserialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like