EditableSchema::fields() - Code Metrics - Inspection of "updated specs, removed the foreign keys hack, upda..." - OriHoch/tableschema-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cd378b...329175 )

by Ori

created 2017-07-06 16:28 UTC

EditableSchema::fields() B

↳ Parent: EditableSchema

Complexity

Conditions	6
Paths	6

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	13
nc	6
nop	1
dl	0
loc	19
rs	8.8571
c	0
b	0
f	0

<?php

namespace frictionlessdata\tableschema;

use frictionlessdata\tableschema\Fields\BaseField;
use frictionlessdata\tableschema\Fields\FieldsFactory;

class EditableSchema extends Schema
{
    public function __construct($descriptor = null)
    {
        $this->descriptor = empty($descriptor) ? (object) ['fields' => []] : $descriptor;
    }

    public function fields($newFields = null)
    {
        if (!is_null($newFields)) {
            $this->descriptor()->fields = [];
            $this->fieldsCache = [];
            foreach ($newFields as $name => $field) {
                if (!is_a($field, "frictionlessdata\\tableschema\\Fields\\BaseField")) {
                    if (!isset($field->name)) $field->name = $name;
                    $field = FieldsFactory::field($field);
                }
                $this->fieldsCache[$name] = $field;
                $this->descriptor()->fields[] = $field->descriptor();
            }

            return $this->revalidate();
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());
}
        } else {
            return is_null($this->fieldsCache) ? [] : $this->fieldsCache;
        }
    }

    public function field($name, $field = null)
    {
        $fields = $this->fields();
        if (!is_null($field)) {
            $fields[$name] = $field;

            return $this->fields($fields);
        } elseif (array_key_exists($name, $fields)) {
            return $fields[$name];
        } else {
            throw new \Exception("unknown field name: {$name}");
        }
    }

    public function removeField($name)
    {
        $fields = $this->fields();
        unset($fields[$name]);

        return $this->fields($fields);
    }

    public function primaryKey($primaryKey = null)

    {
        if (is_null($primaryKey)) {
            return parent::primaryKey();
        } else {
            $this->descriptor()->primaryKey = $primaryKey;

            return $this->revalidate();
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());
}
        }
    }

    public function foreignKeys($foreignKeys = null)

    {
        if (is_null($foreignKeys)) {
            return parent::foreignKeys();
        } else {
            $this->descriptor()->foreignKeys = $foreignKeys;

            return $this->revalidate();
        }
    }

    public function missingValues($missingValues = null)

    {
        if (is_null($missingValues)) {
            return parent::missingValues();
        } else {
            $this->descriptor()->missingValues = $missingValues;

            return $this->revalidate();
        }
    }

    public function revalidate()
    {
        $validationErrors = SchemaValidator::validate($this->descriptor());
        if (count($validationErrors) > 0) {
            throw new Exceptions\SchemaValidationFailedException($validationErrors);
        } else {
            return $this;
        }
    }
}


1		<?php
2
3		namespace frictionlessdata\tableschema;
4
5		use frictionlessdata\tableschema\Fields\BaseField;
6		use frictionlessdata\tableschema\Fields\FieldsFactory;
7
8		class EditableSchema extends Schema
9		{
10		public function __construct($descriptor = null)
11		{
12		$this->descriptor = empty($descriptor) ? (object) ['fields' => []] : $descriptor;
13		}
14
15		public function fields($newFields = null)
16		{
17		if (!is_null($newFields)) {
18		$this->descriptor()->fields = [];
19		$this->fieldsCache = [];
20		foreach ($newFields as $name => $field) {
21		if (!is_a($field, "frictionlessdata\\tableschema\\Fields\\BaseField")) {
22		if (!isset($field->name)) $field->name = $name;
23		$field = FieldsFactory::field($field);
24		}
25		$this->fieldsCache[$name] = $field;
26		$this->descriptor()->fields[] = $field->descriptor();
27		}
28
29		return $this->revalidate();
		0 ignored issues – show Bug Best Practice introduced 2017-06-29 10:50 UTC by Report Bug Copy Issue Report The return type of `return $this->revalidate();` (`frictionlessdata\tableschema\EditableSchema`) is incompatible with the return type of the parent method `frictionlessdata\tableschema\Schema::fields` of type `frictionlessdata\tableschema\Fields\BaseField[]`. 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...
30		} else {
31		return is_null($this->fieldsCache) ? [] : $this->fieldsCache;
32		}
33		}
34
35		public function field($name, $field = null)
36		{
37		$fields = $this->fields();
38		if (!is_null($field)) {
39		$fields[$name] = $field;
40
41		return $this->fields($fields);
42		} elseif (array_key_exists($name, $fields)) {
43		return $fields[$name];
44		} else {
45		throw new \Exception("unknown field name: {$name}");
46		}
47		}
48
49		public function removeField($name)
50		{
51		$fields = $this->fields();
52		unset($fields[$name]);
53
54		return $this->fields($fields);
55		}
56
57	View Code Duplication	public function primaryKey($primaryKey = null)
		0 ignored issues – show Duplication introduced 2017-06-29 10:50 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...
58		{
59		if (is_null($primaryKey)) {
60		return parent::primaryKey();
61		} else {
62		$this->descriptor()->primaryKey = $primaryKey;
63
64		return $this->revalidate();
		0 ignored issues – show Bug Best Practice introduced 2017-06-29 10:50 UTC by Report Bug Copy Issue Report The return type of `return $this->revalidate();` (`frictionlessdata\tableschema\EditableSchema`) is incompatible with the return type of the parent method `frictionlessdata\tableschema\Schema::primaryKey` of type `array`. 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...
65		}
66		}
67
68	View Code Duplication	public function foreignKeys($foreignKeys = null)
		0 ignored issues – show Duplication introduced 2017-06-29 10:50 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...
69		{
70		if (is_null($foreignKeys)) {
71		return parent::foreignKeys();
72		} else {
73		$this->descriptor()->foreignKeys = $foreignKeys;
74
75		return $this->revalidate();
76		}
77		}
78
79	View Code Duplication	public function missingValues($missingValues = null)
		0 ignored issues – show Duplication introduced 2017-06-29 10:50 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...
80		{
81		if (is_null($missingValues)) {
82		return parent::missingValues();
83		} else {
84		$this->descriptor()->missingValues = $missingValues;
85
86		return $this->revalidate();
87		}
88		}
89
90		public function revalidate()
91		{
92		$validationErrors = SchemaValidator::validate($this->descriptor());
93		if (count($validationErrors) > 0) {
94		throw new Exceptions\SchemaValidationFailedException($validationErrors);
95		} else {
96		return $this;
97		}
98		}
99		}
100

OriHoch / tableschema-php

Push — master ( cd378b...329175 )

EditableSchema::fields() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like