SchemaValidator::validateKeys() - Code Metrics - Inspection of "Code style fixes (#23)" - OriHoch/tableschema-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 77c4c6...fbe049 )

by Ori

created 2017-06-29 10:45 UTC

SchemaValidator::validateKeys() C

↳ Parent: SchemaValidator

Complexity

Conditions	13
Paths	78

Size

Total Lines	41
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	25
nc	78
nop	0
dl	0
loc	41
rs	5.1234
c	0
b	0
f	0

How to fix Complexity

<?php

namespace frictionlessdata\tableschema;

/**
 * validates a table schema descriptor object
 * returns a list of validation errors.
 */
class SchemaValidator
{
    /**
     * @param object $descriptor
     *
     * @return SchemaValidationError[]
     */
    public static function validate($descriptor)
    {
        $validator = new self($descriptor);

        return $validator->getValidationErrors();
    }

    /**
     * @param object $descriptor
     */
    public function __construct($descriptor)
    {
        $this->descriptor = $descriptor;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->errors = [];
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @return SchemaValidationError[]
     */
    public function getValidationErrors()
    {
        $this->errors = [];
        $this->validateSchema();
        if (count($this->errors) == 0) {
            $this->validateKeys();
        }

        return $this->errors;
    }

    /**
     * @param int   $code
     * @param mixed $extraDetails
     */
    protected function addError($code, $extraDetails = null)
    {
        $this->errors[] = new SchemaValidationError($code, $extraDetails);
    }

    protected function validateSchema()
    {
        // Validate
        $validator = new \JsonSchema\Validator();
        $descriptor = json_decode(json_encode($this->descriptor));
        $this->applyForeignKeysResourceHack($descriptor);
        $validator->validate(
            $descriptor,
            (object) ['$ref' => 'file://'.realpath(dirname(__FILE__)).'/schemas/table-schema.json']
        );
        if (!$validator->isValid()) {
            foreach ($validator->getErrors() as $error) {
                $this->addError(
                    SchemaValidationError::SCHEMA_VIOLATION,
                    sprintf('[%s] %s', $error['property'], $error['message'])
                );
            }
        }
    }

    protected function validateKeys()
    {
        $fieldNames = array_map(function ($field) {
            return $field->name;
        }, $this->descriptor->fields);
        if (isset($this->descriptor->primaryKey)) {
            $primaryKey = is_array($this->descriptor->primaryKey) ? $this->descriptor->primaryKey : [$this->descriptor->primaryKey];
            foreach ($primaryKey as $primaryKeyField) {
                if (!in_array($primaryKeyField, $fieldNames)) {
                    $this->addError(
                        SchemaValidationError::SCHEMA_VIOLATION,
                        "primary key must refer to a field name ({$primaryKeyField})"
                    );
                }
            }
        }
        if (isset($this->descriptor->foreignKeys)) {
            foreach ($this->descriptor->foreignKeys as $foreignKey) {
                $fields = is_array($foreignKey->fields) ? $foreignKey->fields : [$foreignKey->fields];
                foreach ($fields as $field) {
                    if (!in_array($field, $fieldNames)) {
                        $this->addError(
                            SchemaValidationError::SCHEMA_VIOLATION,
                            "foreign key fields must refer to a field name ({$field})"
                        );
                    }
                }
                if ($foreignKey->reference->resource == '') {
                    // empty resource = reference to self
                    foreach ($foreignKey->reference->fields as $field) {
                        if (!in_array($field, $fieldNames)) {
                            $this->addError(
                                SchemaValidationError::SCHEMA_VIOLATION,
                                "foreign key reference to self must refer to a field name ({$field})"
                            );
                        }
                    }
                }
            }
        }
    }

    protected function applyForeignKeysResourceHack($descriptor)
    {
        if (isset($descriptor->foreignKeys) && is_array($descriptor->foreignKeys)) {
            foreach ($descriptor->foreignKeys as $foreignKey) {
                // the resource field of foreign keys has problems validating as standard uri string
                // we just override the validation entirely by placing a valid uri
                if (
                    is_object($foreignKey)
                    && isset($foreignKey->reference) && is_object($foreignKey->reference)
                    && isset($foreignKey->reference->resource) && !empty($foreignKey->reference->resource)
                ) {
                    $foreignKey->reference->resource = 'void://'.$foreignKey->reference->resource;
                }
            }
        }
    }
}


1			<?php
2
3			namespace frictionlessdata\tableschema;
4
5			/**
6			* validates a table schema descriptor object
7			* returns a list of validation errors.
8			*/
9			class SchemaValidator
10			{
11			/**
12			* @param object $descriptor
13			*
14			* @return SchemaValidationError[]
15			*/
16			public static function validate($descriptor)
17			{
18			$validator = new self($descriptor);
19
20			return $validator->getValidationErrors();
21			}
22
23			/**
24			* @param object $descriptor
25			*/
26			public function __construct($descriptor)
27			{
28			$this->descriptor = $descriptor;
			0 ignored issues – show Bug introduced 2017-04-18 05:57 UTC by Report Bug Copy Issue Report The property `descriptor` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29			$this->errors = [];
			0 ignored issues – show Bug introduced 2017-04-27 14:43 UTC by Report Bug Copy Issue Report The property `errors` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
30			}
31
32			/**
33			* @return SchemaValidationError[]
34			*/
35			public function getValidationErrors()
36			{
37			$this->errors = [];
38			$this->validateSchema();
39			if (count($this->errors) == 0) {
40			$this->validateKeys();
41			}
42
43			return $this->errors;
44			}
45
46			/**
47			* @param int $code
48			* @param mixed $extraDetails
49			*/
50			protected function addError($code, $extraDetails = null)
51			{
52			$this->errors[] = new SchemaValidationError($code, $extraDetails);
53			}
54
55			protected function validateSchema()
56			{
57			// Validate
58			$validator = new \JsonSchema\Validator();
59			$descriptor = json_decode(json_encode($this->descriptor));
60			$this->applyForeignKeysResourceHack($descriptor);
61			$validator->validate(
62			$descriptor,
63			(object) ['$ref' => 'file://'.realpath(dirname(__FILE__)).'/schemas/table-schema.json']
64			);
65			if (!$validator->isValid()) {
66			foreach ($validator->getErrors() as $error) {
67			$this->addError(
68			SchemaValidationError::SCHEMA_VIOLATION,
69			sprintf('[%s] %s', $error['property'], $error['message'])
70			);
71			}
72			}
73			}
74
75			protected function validateKeys()
76			{
77			$fieldNames = array_map(function ($field) {
78			return $field->name;
79			}, $this->descriptor->fields);
80			if (isset($this->descriptor->primaryKey)) {
81			$primaryKey = is_array($this->descriptor->primaryKey) ? $this->descriptor->primaryKey : [$this->descriptor->primaryKey];
82			foreach ($primaryKey as $primaryKeyField) {
83			if (!in_array($primaryKeyField, $fieldNames)) {
84			$this->addError(
85			SchemaValidationError::SCHEMA_VIOLATION,
86			"primary key must refer to a field name ({$primaryKeyField})"
87			);
88			}
89			}
90			}
91			if (isset($this->descriptor->foreignKeys)) {
92			foreach ($this->descriptor->foreignKeys as $foreignKey) {
93			$fields = is_array($foreignKey->fields) ? $foreignKey->fields : [$foreignKey->fields];
94			foreach ($fields as $field) {
95			if (!in_array($field, $fieldNames)) {
96			$this->addError(
97			SchemaValidationError::SCHEMA_VIOLATION,
98			"foreign key fields must refer to a field name ({$field})"
99			);
100			}
101			}
102			if ($foreignKey->reference->resource == '') {
103			// empty resource = reference to self
104			foreach ($foreignKey->reference->fields as $field) {
105			if (!in_array($field, $fieldNames)) {
106			$this->addError(
107			SchemaValidationError::SCHEMA_VIOLATION,
108			"foreign key reference to self must refer to a field name ({$field})"
109			);
110			}
111			}
112			}
113			}
114			}
115			}
116
117			protected function applyForeignKeysResourceHack($descriptor)
118			{
119			if (isset($descriptor->foreignKeys) && is_array($descriptor->foreignKeys)) {
120			foreach ($descriptor->foreignKeys as $foreignKey) {
121			// the resource field of foreign keys has problems validating as standard uri string
122			// we just override the validation entirely by placing a valid uri
123			if (
124			is_object($foreignKey)
125			&& isset($foreignKey->reference) && is_object($foreignKey->reference)
126			&& isset($foreignKey->reference->resource) && !empty($foreignKey->reference->resource)
127			) {
128			$foreignKey->reference->resource = 'void://'.$foreignKey->reference->resource;
129			}
130			}
131			}
132			}
133			}
134

OriHoch / tableschema-php

Push — master ( 77c4c6...fbe049 )

SchemaValidator::validateKeys() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like