TwitterDisconnectSerializer::canSerialize() - 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

TwitterDisconnectSerializer::canSerialize() A

↳ Parent: TwitterDisconnectSerializer

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\TwitterDisconnect;
use Twitter\TwitterSerializable;
use Twitter\TwitterSerializer;

class TwitterDisconnectSerializer 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 TwitterDisconnect');
        }

        $obj = new \stdClass();
        $obj->code = $object->getCode();
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.
    }
}
        $obj->stream_name = $object->getStreamName();
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.
    }
}
        $obj->reason = $object->getReason();
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.
    }
}

        $disconnect = new \stdClass();
        $disconnect->disconnect = $obj;

        return $disconnect;
    }

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

        $d = $obj->disconnect;

        return TwitterDisconnect::create(
            $d->code,
            $d->stream_name,
            $d->reason
        );
    }

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

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

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


1		<?php
2
3		namespace Twitter\Serializer;
4
5		use Twitter\Object\TwitterDisconnect;
6		use Twitter\TwitterSerializable;
7		use Twitter\TwitterSerializer;
8
9		class TwitterDisconnectSerializer 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 TwitterDisconnect');
19		}
20
21	3	$obj = new \stdClass();
22	3	$obj->code = $object->getCode();
		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 `getCode()` does only exist in the following implementations of said interface: `Twitter\Object\TwitterDisconnect`. 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	$obj->stream_name = $object->getStreamName();
		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 `getStreamName()` does only exist in the following implementations of said interface: `Twitter\Object\TwitterDisconnect`. 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	3	$obj->reason = $object->getReason();
		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 `getReason()` does only exist in the following implementations of said interface: `Twitter\Object\TwitterDisconnect`. 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...
25
26	3	$disconnect = new \stdClass();
27	3	$disconnect->disconnect = $obj;
28
29	3	return $disconnect;
30		}
31
32		/**
33		* @param \stdClass $obj
34		* @param array $context
35		* @return TwitterDisconnect
36		*/
37	3	public function unserialize($obj, array $context = [])
38		{
39	3	if (!$this->canUnserialize($obj)) {
40		throw new \InvalidArgumentException('$object is not unserializable');
41	3	}
42	3
43	3	$d = $obj->disconnect;
44	3
45	2	return TwitterDisconnect::create(
46		$d->code,
47		$d->stream_name,
48		$d->reason
49		);
50		}
51	6
52		/**
53	6	* @param TwitterSerializable $object
54		* @return boolean
55		*/
56		public function canSerialize(TwitterSerializable $object)
57		{
58		return $object instanceof TwitterDisconnect;
59		}
60
61		/**
62		* @param \stdClass $object
63		* @return boolean
64		*/
65		public function canUnserialize($object)
66		{
67		return (isset($object->disconnect));
68		}
69
70		/**
71		* @return TwitterDisconnectSerializer
72		*/
73		public static function build()
74		{
75		return new self();
76		}
77		}
78

remi-san / twitter

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

TwitterDisconnectSerializer::canSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like