SchemaParser::createField() - Code Metrics - Inspection of "Extended Commands" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1088)

unknown

created 2020-10-07 20:01 UTC

SchemaParser::createField() A

↳ Parent: SchemaParser

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
cc	3
nc	3
nop	3
dl	0
loc	14
ccs	6
cts	7
cp	0.8571
crap	3.0261
rs	9.7998
c	0
b	0
f	0

<?php

namespace Nwidart\Modules\Support\Migrations;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

class SchemaParser implements Arrayable
{
    /**
     * The array of custom attributes.
     *
     * @var array
     */
    protected $customAttributes = [
        'remember_token' => 'rememberToken()',
        'soft_delete' => 'softDeletes()',
    ];

    /**
     * The migration schema.
     *
     * @var string
     */
    protected $schema;

    /**
     * The relationship keys.
     *
     * @var array
     */
    protected $relationshipKeys = [
        'belongsTo',
    ];

    /**
     * Create new instance.
     *
     * @param string|null $schema
     */
    public function __construct($schema = null)
    {
        $this->schema = $schema;
    }

    /**
     * Parse a string to array of formatted schema.
     *
     * @param string $schema
     *
     * @return array
     */
    public function parse($schema)
    {
        $this->schema = $schema;

        $parsed = [];

        foreach ($this->getSchemas() as $schemaArray) {
            $column = $this->getColumn($schemaArray);

            $attributes = $this->getAttributes($column, $schemaArray);

            $parsed[$column] = $attributes;
        }

        return $parsed;
    }

    /**
     * Get array of schema.
     *
     * @return array
     */
    public function getSchemas()
    {
        if (is_null($this->schema)) {
            return [];
        }

        return explode(',', str_replace(' ', '', $this->schema));
    }

    /**
     * Convert string migration to array.
     *
     * @return array
     */
    public function toArray()
    {
        return $this->parse($this->schema);
    }

    /**
     * Render the migration to formatted script.
     *
     * @return string
     */
    public function render()
    {
        $results = '';

        foreach ($this->toArray() as $column => $attributes) {
            $results .= $this->createField($column, $attributes);
        }

        return $results;
    }

    /**
     * Render up migration fields.
     *
     * @return string
     */
    public function up()
    {
        return $this->render();
    }

    /**
     * Render down migration fields.
     *
     * @return string
     */
    public function down()
    {
        $results = '';

        foreach ($this->toArray() as $column => $attributes) {
            $attributes = [head($attributes)];
            $results .= $this->createField($column, $attributes, 'remove');
        }

        return $results;
    }

    /**
     * Create field.
     *
     * @param string $column
     * @param array  $attributes
     * @param string $type
     *
     * @return string
     */
    public function createField($column, $attributes, $type = 'add')
    {
        $results = "\t\t\t" . '$table';

        foreach ($attributes as $key => $field) {
            if (in_array($column, $this->relationshipKeys)) {
                $results .= $this->addRelationColumn($key, $field, $column);
            } else {
                $results .= $this->{"{$type}Column"}($key, $field, $column);
            }
        }

        return $results . ';' . PHP_EOL;
    }

    /**
     * Add relation column.
     *
     * @param int    $key
     * @param string $field
     * @param string $column
     *
     * @return string
     */
    protected function addRelationColumn($key, $field, $column)

    {
        if ($key === 0) {
            $relatedColumn = Str::snake(class_basename($field)) . '_id';

            return "->integer('{$relatedColumn}')->unsigned();" . PHP_EOL . "\t\t\t" . "\$table->foreign('{$relatedColumn}')";
        }
        if ($key === 1) {
            return "->references('{$field}')";
        }
        if ($key === 2) {
            return "->on('{$field}')";
        }
        if (Str::contains($field, '(')) {
            return '->' . $field;
        }

        return '->' . $field . '()';
    }

    /**
     * Format field to script.
     *
     * @param int    $key
     * @param string $field
     * @param string $column
     *
     * @return string
     */
    protected function addColumn($key, $field, $column)
    {
        if ($this->hasCustomAttribute($column)) {
            return '->' . $field;
        }

        if ($key == 0) {
            return '->' . $field . "('" . $column . "')";
        }

        if (Str::contains($field, '(')) {
            return '->' . $field;
        }

        return '->' . $field . '()';
    }

    /**
     * Format field to script.
     *
     * @param int    $key
     * @param string $field
     * @param string $column
     *
     * @return string
     */
    protected function removeColumn($key, $field, $column)

    {
        if ($this->hasCustomAttribute($column)) {
            return '->' . $field;
        }

        return '->dropColumn(' . "'" . $column . "')";
    }

    /**
     * Get column name from schema.
     *
     * @param string $schema
     *
     * @return string
     */
    public function getColumn($schema)
    {
        return Arr::get(explode(':', $schema), 0);
    }

    /**
     * Get column attributes.
     *
     * @param string $column
     * @param string $schema
     *
     * @return array
     */
    public function getAttributes($column, $schema)
    {
        $fields = str_replace($column . ':', '', $schema);

        return $this->hasCustomAttribute($column) ? $this->getCustomAttribute($column) : explode(':', $fields);
    }

    /**
     * Determine whether the given column is exist in customAttributes array.
     *
     * @param string $column
     *
     * @return bool
     */
    public function hasCustomAttribute($column)
    {
        return array_key_exists($column, $this->customAttributes);
    }

    /**
     * Get custom attributes value.
     *
     * @param string $column
     *
     * @return array
     */
    public function getCustomAttribute($column)
    {
        return (array) $this->customAttributes[$column];
    }
}


1		<?php
2
3		namespace Nwidart\Modules\Support\Migrations;
4
5		use Illuminate\Contracts\Support\Arrayable;
6		use Illuminate\Support\Arr;
7		use Illuminate\Support\Str;
8
9		class SchemaParser implements Arrayable
10		{
11		/**
12		* The array of custom attributes.
13		*
14		* @var array
15		*/
16		protected $customAttributes = [
17		'remember_token' => 'rememberToken()',
18		'soft_delete' => 'softDeletes()',
19		];
20
21		/**
22		* The migration schema.
23		*
24		* @var string
25		*/
26		protected $schema;
27
28		/**
29		* The relationship keys.
30		*
31		* @var array
32		*/
33		protected $relationshipKeys = [
34		'belongsTo',
35		];
36
37		/**
38		* Create new instance.
39		*
40		* @param string\|null $schema
41		*/
42	3	public function __construct($schema = null)
43		{
44	3	$this->schema = $schema;
45	3	}
46
47		/**
48		* Parse a string to array of formatted schema.
49		*
50		* @param string $schema
51		*
52		* @return array
53		*/
54	3	public function parse($schema)
55		{
56	3	$this->schema = $schema;
57
58	3	$parsed = [];
59
60	3	foreach ($this->getSchemas() as $schemaArray) {
61	3	$column = $this->getColumn($schemaArray);
62
63	3	$attributes = $this->getAttributes($column, $schemaArray);
64
65	3	$parsed[$column] = $attributes;
66		}
67
68	3	return $parsed;
69		}
70
71		/**
72		* Get array of schema.
73		*
74		* @return array
75		*/
76	3	public function getSchemas()
77		{
78	3	if (is_null($this->schema)) {
79		return [];
80		}
81
82	3	return explode(',', str_replace(' ', '', $this->schema));
83		}
84
85		/**
86		* Convert string migration to array.
87		*
88		* @return array
89		*/
90	3	public function toArray()
91		{
92	3	return $this->parse($this->schema);
93		}
94
95		/**
96		* Render the migration to formatted script.
97		*
98		* @return string
99		*/
100	2	public function render()
101		{
102	2	$results = '';
103
104	2	foreach ($this->toArray() as $column => $attributes) {
105	2	$results .= $this->createField($column, $attributes);
106		}
107
108	2	return $results;
109		}
110
111		/**
112		* Render up migration fields.
113		*
114		* @return string
115		*/
116	1	public function up()
117		{
118	1	return $this->render();
119		}
120
121		/**
122		* Render down migration fields.
123		*
124		* @return string
125		*/
126	1	public function down()
127		{
128	1	$results = '';
129
130	1	foreach ($this->toArray() as $column => $attributes) {
131	1	$attributes = [head($attributes)];
132	1	$results .= $this->createField($column, $attributes, 'remove');
133		}
134
135	1	return $results;
136		}
137
138		/**
139		* Create field.
140		*
141		* @param string $column
142		* @param array $attributes
143		* @param string $type
144		*
145		* @return string
146		*/
147	3	public function createField($column, $attributes, $type = 'add')
148		{
149	3	$results = "\t\t\t" . '$table';
150
151	3	foreach ($attributes as $key => $field) {
152	3	if (in_array($column, $this->relationshipKeys)) {
153		$results .= $this->addRelationColumn($key, $field, $column);
154		} else {
155	3	$results .= $this->{"{$type}Column"}($key, $field, $column);
156		}
157		}
158
159	3	return $results . ';' . PHP_EOL;
160		}
161
162		/**
163		* Add relation column.
164		*
165		* @param int $key
166		* @param string $field
167		* @param string $column
168		*
169		* @return string
170		*/
171		protected function addRelationColumn($key, $field, $column)
		0 ignored issues – show Unused Code introduced 2017-07-31 09:04 UTC by Report Bug Copy Issue Report The parameter `$column` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
172		{
173		if ($key === 0) {
174		$relatedColumn = Str::snake(class_basename($field)) . '_id';
175
176		return "->integer('{$relatedColumn}')->unsigned();" . PHP_EOL . "\t\t\t" . "\$table->foreign('{$relatedColumn}')";
177		}
178		if ($key === 1) {
179		return "->references('{$field}')";
180		}
181		if ($key === 2) {
182		return "->on('{$field}')";
183		}
184		if (Str::contains($field, '(')) {
185		return '->' . $field;
186		}
187
188		return '->' . $field . '()';
189		}
190
191		/**
192		* Format field to script.
193		*
194		* @param int $key
195		* @param string $field
196		* @param string $column
197		*
198		* @return string
199		*/
200	2	protected function addColumn($key, $field, $column)
201		{
202	2	if ($this->hasCustomAttribute($column)) {
203		return '->' . $field;
204		}
205
206	2	if ($key == 0) {
207	2	return '->' . $field . "('" . $column . "')";
208		}
209
210		if (Str::contains($field, '(')) {
211		return '->' . $field;
212		}
213
214		return '->' . $field . '()';
215		}
216
217		/**
218		* Format field to script.
219		*
220		* @param int $key
221		* @param string $field
222		* @param string $column
223		*
224		* @return string
225		*/
226	1	protected function removeColumn($key, $field, $column)
		0 ignored issues – show Unused Code introduced 2017-07-31 09:04 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
227		{
228	1	if ($this->hasCustomAttribute($column)) {
229		return '->' . $field;
230		}
231
232	1	return '->dropColumn(' . "'" . $column . "')";
233		}
234
235		/**
236		* Get column name from schema.
237		*
238		* @param string $schema
239		*
240		* @return string
241		*/
242	3	public function getColumn($schema)
243		{
244	3	return Arr::get(explode(':', $schema), 0);
245		}
246
247		/**
248		* Get column attributes.
249		*
250		* @param string $column
251		* @param string $schema
252		*
253		* @return array
254		*/
255	3	public function getAttributes($column, $schema)
256		{
257	3	$fields = str_replace($column . ':', '', $schema);
258
259	3	return $this->hasCustomAttribute($column) ? $this->getCustomAttribute($column) : explode(':', $fields);
260		}
261
262		/**
263		* Determine whether the given column is exist in customAttributes array.
264		*
265		* @param string $column
266		*
267		* @return bool
268		*/
269	3	public function hasCustomAttribute($column)
270		{
271	3	return array_key_exists($column, $this->customAttributes);
272		}
273
274		/**
275		* Get custom attributes value.
276		*
277		* @param string $column
278		*
279		* @return array
280		*/
281		public function getCustomAttribute($column)
282		{
283		return (array) $this->customAttributes[$column];
284		}
285		}
286

nWidart / laravel-modules

Pull Request — master (#1088)

SchemaParser::createField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like