GeoCoordinatesUpdated - Code Metrics - Inspection of "III-2468 Geocoding for events with dummy locations..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#340)

by Luc

created 2018-01-26 12:57 UTC

GeoCoordinatesUpdated A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	53
Duplicated Lines	100 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	4
c	0
b	0
f	0
lcom	1
cbo	4
dl	53
loc	53
rs	10

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	5	5	1
A	getCoordinates()	4	4	1
A	serialize()	9	9	1
A	deserialize()	10	10	1

How to fix Duplicated Code

<?php

namespace CultuurNet\UDB3\Event\Events;

use CultuurNet\Geocoding\Coordinate\Coordinates;
use CultuurNet\Geocoding\Coordinate\Latitude;
use CultuurNet\Geocoding\Coordinate\Longitude;
use CultuurNet\UDB3\Event\EventEvent;

class GeoCoordinatesUpdated extends EventEvent

{
    /**
     * @var Coordinates
     */
    private $coordinates;

    /**
     * @param string $eventId
     * @param Coordinates $coordinates
     */
    public function __construct($eventId, Coordinates $coordinates)
    {
        parent::__construct($eventId);
        $this->coordinates = $coordinates;
    }

    /**
     * @return Coordinates
     */
    public function getCoordinates()
    {
        return $this->coordinates;
    }

    /**
     * @return array
     */
    public function serialize()
    {
        return parent::serialize() + [
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
                'coordinates' => [
                    'lat' => $this->coordinates->getLatitude()->toDouble(),
                    'long' => $this->coordinates->getLongitude()->toDouble(),
                ],
            ];
    }

    /**
     * @param array $data
     * @return GeoCoordinatesUpdated
     */
    public static function deserialize(array $data)
    {
        return new GeoCoordinatesUpdated(
            $data['event_id'],
            new Coordinates(
                new Latitude($data['coordinates']['lat']),
                new Longitude($data['coordinates']['long'])
            )
        );
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\Event\Events;
4
5		use CultuurNet\Geocoding\Coordinate\Coordinates;
6		use CultuurNet\Geocoding\Coordinate\Latitude;
7		use CultuurNet\Geocoding\Coordinate\Longitude;
8		use CultuurNet\UDB3\Event\EventEvent;
9
10	View Code Duplication	class GeoCoordinatesUpdated extends EventEvent
		0 ignored issues – show Duplication introduced 2018-01-26 13:02 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
11		{
12		/**
13		* @var Coordinates
14		*/
15		private $coordinates;
16
17		/**
18		* @param string $eventId
19		* @param Coordinates $coordinates
20		*/
21		public function __construct($eventId, Coordinates $coordinates)
22		{
23		parent::__construct($eventId);
24		$this->coordinates = $coordinates;
25		}
26
27		/**
28		* @return Coordinates
29		*/
30		public function getCoordinates()
31		{
32		return $this->coordinates;
33		}
34
35		/**
36		* @return array
37		*/
38		public function serialize()
39		{
40		return parent::serialize() + [
		0 ignored issues – show Best Practice introduced 2018-01-26 13:02 UTC by Report Bug Copy Issue Report The expression `return parent::serialize...gitude()->toDouble()));` seems to be an `array`, but some of its elements' types (`array`) are incompatible with the return type of the parent method `CultuurNet\UDB3\Event\EventEvent::serialize` of type `array<string,string>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
41		'coordinates' => [
42		'lat' => $this->coordinates->getLatitude()->toDouble(),
43		'long' => $this->coordinates->getLongitude()->toDouble(),
44		],
45		];
46		}
47
48		/**
49		* @param array $data
50		* @return GeoCoordinatesUpdated
51		*/
52		public static function deserialize(array $data)
53		{
54		return new GeoCoordinatesUpdated(
55		$data['event_id'],
56		new Coordinates(
57		new Latitude($data['coordinates']['lat']),
58		new Longitude($data['coordinates']['long'])
59		)
60		);
61		}
62		}
63

cultuurnet / udb3-php

Pull Request — master (#340)

GeoCoordinatesUpdated A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like