Model - Code Metrics - Inspection of "Use Carbon for DateTimes and fix Model serialisati..." - duxet/laravel-rethinkdb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

unknown

created 2016-08-21 13:49 UTC

Model A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	173
Duplicated Lines	9.25 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes	13
Bugs	10	Features	2

Metric	Value
wmc	24
c	13
b	10
f	2
lcom	2
cbo	7
dl	16
loc	173
rs	10

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getQualifiedKeyName()	0	4	1
A	getDateFormat()	0	4	2
A	asDateTime()	0	9	2
A	fromDateTime()	0	8	2
A	newBaseQueryBuilder()	0	10	2
A	newEloquentBuilder()	0	4	1
B	belongsTo()	0	24	4
A	hasOne()	8	8	3
A	hasMany()	8	8	3
A	originalIsNumericallyEquivalent()	0	12	4

How to fix Duplicated Code

<?php

namespace duxet\Rethinkdb\Eloquent;

use DateTime;
use Carbon\Carbon;
use duxet\Rethinkdb\Eloquent\Relations\BelongsTo;
use duxet\Rethinkdb\Query\Builder as QueryBuilder;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasOne;

class Model extends \Illuminate\Database\Eloquent\Model
{
    /**
     * Get the format for database stored dates.
     *
     * @return string
     */
    protected function getDateFormat()
    {
        return $this->dateFormat ?: 'Y-m-d H:i:s';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Get the table qualified key name.
     *
     * @return string
     */
    public function getQualifiedKeyName()
    {
        return $this->getKeyName();
    }

    /**
     * Ensure Timestamps are returned in DateTime.
     *
     * @param \DateTime $value
     *
     * @return \DateTime
     */
    protected function asDateTime($value)
    {
        // Legacy support for Laravel 5.0
        if (!$value instanceof Carbon) {
            return Carbon::instance($value);
        }

        return parent::asDateTime($value);
    }

    /**
     * Retain DateTime format for storage.
     *
     * @param \DateTime $value
     *
     * @return string
     */
    public function fromDateTime($value)
    {
        if ($value instanceof DateTime) {
            return $value;
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 parent::asDateTime($value);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Get a new query builder instance for the connection.
     *
     * @return Builder
     */
    protected function newBaseQueryBuilder()
    {
        $connection = $this->getConnection();
        // Check the connection type
        if ($connection instanceof \duxet\Rethinkdb\Connection) {
            return new QueryBuilder($connection);
        }

        return parent::newBaseQueryBuilder();
    }

    /**
     * Create a new Eloquent query builder for the model.
     *
     * @param \duxet\Rethinkdb\Query\Builder $query
     *
     * @return \duxet\Rethinkdb\Eloquent\Builder|static
     */
    public function newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    /**
     * Define an inverse one-to-one or many relationship.
     *
     * @param string $related
     * @param string $foreignKey
     * @param string $otherKey
     * @param string $relation
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function belongsTo($related, $foreignKey = null, $otherKey = null, $relation = null)
    {
        // If no relation name was given, we will use this debug backtrace to extract
        // the calling method's name and use that as the relationship name as most
        // of the time this will be what we desire to use for the relationships.
        if (is_null($relation)) {
            list(, $caller) = debug_backtrace(false, 2);
            $relation = $caller['function'];
        }
        // If no foreign key was supplied, we can use a backtrace to guess the proper
        // foreign key name by using the name of the relationship function, which
        // when combined with an "_id" should conventionally match the columns.
        if (is_null($foreignKey)) {
            $foreignKey = snake_case($relation).'_id';
        }
        $instance = new $related();
        // Once we have the foreign key names, we'll just create a new Eloquent query
        // for the related models and returns the relationship instance which will
        // actually be responsible for retrieving and hydrating every relations.
        $query = $instance->newQuery();
        $otherKey = $otherKey ?: $instance->getKeyName();

        return new BelongsTo($query, $this, $foreignKey, $otherKey, $relation);
    }

    /**
     * Define a one-to-one relationship.
     *
     * @param string $related
     * @param string $foreignKey
     * @param string $localKey
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function hasOne($related, $foreignKey = null, $localKey = null)

    {
        $foreignKey = $foreignKey ?: $this->getForeignKey();
        $instance = new $related();
        $localKey = $localKey ?: $this->getKeyName();

        return new HasOne($instance->newQuery(), $this, $foreignKey, $localKey);
    }

    /**
     * Define a one-to-many relationship.
     *
     * @param string $related
     * @param string $foreignKey
     * @param string $localKey
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function hasMany($related, $foreignKey = null, $localKey = null)

    {
        $foreignKey = $foreignKey ?: $this->getForeignKey();
        $instance = new $related();
        $localKey = $localKey ?: $this->getKeyName();

        return new HasMany($instance->newQuery(), $this, $foreignKey, $localKey);
    }

    /**
     * Determine if the new and old values for a given key are numerically equivalent.
     *
     * @param  string  $key
     * @return bool
     */
    protected function originalIsNumericallyEquivalent($key)
    {
        $current = $this->attributes[$key];
        $original = $this->original[$key];
        // Date comparison.
        if (in_array($key, $this->getDates())) {
            $current = $current instanceof DateTime ? $this->asDateTime($current) : $current;
            $original = $original instanceof DateTime ? $this->asDateTime($original) : $original;
            return $current == $original;
        }
        return parent::originalIsNumericallyEquivalent($key);
    }
}


1		<?php
2
3		namespace duxet\Rethinkdb\Eloquent;
4
5		use DateTime;
6		use Carbon\Carbon;
7		use duxet\Rethinkdb\Eloquent\Relations\BelongsTo;
8		use duxet\Rethinkdb\Query\Builder as QueryBuilder;
9		use Illuminate\Database\Eloquent\Relations\HasMany;
10		use Illuminate\Database\Eloquent\Relations\HasOne;
11
12		class Model extends \Illuminate\Database\Eloquent\Model
13		{
14		/**
15		* Get the format for database stored dates.
16		*
17		* @return string
18		*/
19		protected function getDateFormat()
20		{
21		return $this->dateFormat ?: 'Y-m-d H:i:s';
		0 ignored issues – show Documentation introduced 2016-08-21 13:51 UTC by Report Bug Copy Issue Report The property `dateFormat` does not exist on `object<duxet\Rethinkdb\Eloquent\Model>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
22		}
23
24		/**
25		* Get the table qualified key name.
26		*
27		* @return string
28		*/
29		public function getQualifiedKeyName()
30		{
31		return $this->getKeyName();
32		}
33
34		/**
35		* Ensure Timestamps are returned in DateTime.
36		*
37		* @param \DateTime $value
38		*
39		* @return \DateTime
40		*/
41		protected function asDateTime($value)
42		{
43		// Legacy support for Laravel 5.0
44		if (!$value instanceof Carbon) {
45		return Carbon::instance($value);
46		}
47
48		return parent::asDateTime($value);
49		}
50
51		/**
52		* Retain DateTime format for storage.
53		*
54		* @param \DateTime $value
55		*
56		* @return string
57		*/
58		public function fromDateTime($value)
59		{
60		if ($value instanceof DateTime) {
61		return $value;
		0 ignored issues – show Bug Best Practice introduced 2016-08-21 13:51 UTC by Report Bug Copy Issue Report The return type of `return $value;` (`DateTime`) is incompatible with the return type of the parent method `Illuminate\Database\Eloquent\Model::fromDateTime` of type `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 '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()); } 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...
62		}
63
64		return parent::asDateTime($value);
		0 ignored issues – show Comprehensibility Bug introduced 2016-08-21 13:51 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`asDateTime()` instead of `fromDateTime()`). Are you sure this is correct? If so, you might want to change this to `$this->asDateTime()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
65		}
66
67		/**
68		* Get a new query builder instance for the connection.
69		*
70		* @return Builder
71		*/
72		protected function newBaseQueryBuilder()
73		{
74		$connection = $this->getConnection();
75		// Check the connection type
76		if ($connection instanceof \duxet\Rethinkdb\Connection) {
77		return new QueryBuilder($connection);
78		}
79
80		return parent::newBaseQueryBuilder();
81		}
82
83		/**
84		* Create a new Eloquent query builder for the model.
85		*
86		* @param \duxet\Rethinkdb\Query\Builder $query
87		*
88		* @return \duxet\Rethinkdb\Eloquent\Builder\|static
89		*/
90		public function newEloquentBuilder($query)
91		{
92		return new Builder($query);
93		}
94
95		/**
96		* Define an inverse one-to-one or many relationship.
97		*
98		* @param string $related
99		* @param string $foreignKey
100		* @param string $otherKey
101		* @param string $relation
102		*
103		* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
104		*/
105		public function belongsTo($related, $foreignKey = null, $otherKey = null, $relation = null)
106		{
107		// If no relation name was given, we will use this debug backtrace to extract
108		// the calling method's name and use that as the relationship name as most
109		// of the time this will be what we desire to use for the relationships.
110		if (is_null($relation)) {
111		list(, $caller) = debug_backtrace(false, 2);
112		$relation = $caller['function'];
113		}
114		// If no foreign key was supplied, we can use a backtrace to guess the proper
115		// foreign key name by using the name of the relationship function, which
116		// when combined with an "_id" should conventionally match the columns.
117		if (is_null($foreignKey)) {
118		$foreignKey = snake_case($relation).'_id';
119		}
120		$instance = new $related();
121		// Once we have the foreign key names, we'll just create a new Eloquent query
122		// for the related models and returns the relationship instance which will
123		// actually be responsible for retrieving and hydrating every relations.
124		$query = $instance->newQuery();
125		$otherKey = $otherKey ?: $instance->getKeyName();
126
127		return new BelongsTo($query, $this, $foreignKey, $otherKey, $relation);
128		}
129
130		/**
131		* Define a one-to-one relationship.
132		*
133		* @param string $related
134		* @param string $foreignKey
135		* @param string $localKey
136		*
137		* @return \Illuminate\Database\Eloquent\Relations\HasOne
138		*/
139	View Code Duplication	public function hasOne($related, $foreignKey = null, $localKey = null)
		0 ignored issues – show Duplication introduced 2015-11-28 11:20 UTC by Report Bug Copy Issue Report This method 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...
140		{
141		$foreignKey = $foreignKey ?: $this->getForeignKey();
142		$instance = new $related();
143		$localKey = $localKey ?: $this->getKeyName();
144
145		return new HasOne($instance->newQuery(), $this, $foreignKey, $localKey);
146		}
147
148		/**
149		* Define a one-to-many relationship.
150		*
151		* @param string $related
152		* @param string $foreignKey
153		* @param string $localKey
154		*
155		* @return \Illuminate\Database\Eloquent\Relations\HasMany
156		*/
157	View Code Duplication	public function hasMany($related, $foreignKey = null, $localKey = null)
		0 ignored issues – show Duplication introduced 2015-11-28 11:20 UTC by Report Bug Copy Issue Report This method 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...
158		{
159		$foreignKey = $foreignKey ?: $this->getForeignKey();
160		$instance = new $related();
161		$localKey = $localKey ?: $this->getKeyName();
162
163		return new HasMany($instance->newQuery(), $this, $foreignKey, $localKey);
164		}
165
166		/**
167		* Determine if the new and old values for a given key are numerically equivalent.
168		*
169		* @param string $key
170		* @return bool
171		*/
172		protected function originalIsNumericallyEquivalent($key)
173		{
174		$current = $this->attributes[$key];
175		$original = $this->original[$key];
176		// Date comparison.
177		if (in_array($key, $this->getDates())) {
178		$current = $current instanceof DateTime ? $this->asDateTime($current) : $current;
179		$original = $original instanceof DateTime ? $this->asDateTime($original) : $original;
180		return $current == $original;
181		}
182		return parent::originalIsNumericallyEquivalent($key);
183		}
184		}
185

duxet / laravel-rethinkdb

GitHub Access Token became invalid

Pull Request — master (#38)

Model A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like