DoctrineSchemaDiffHelper::formatColumn() - Code Metrics - shapintv/datagen - Measure and Improve Code Quality continuously with Scrutinizer

DoctrineSchemaDiffHelper::formatColumn() A
last analyzed 2020-12-09 10:08 UTC

↳ Parent: DoctrineSchemaDiffHelper

Complexity

Conditions	5
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	10
cts	10
cp	1
rs	9.3554
c	0
b	0
f	0
cc	5
nc	2
nop	1
crap	5

<?php

declare(strict_types=1);

namespace Shapin\Datagen\Bridge\Symfony\Console\Helper;

use Doctrine\DBAL\Schema\Column;
use Doctrine\DBAL\Schema\ColumnDiff;
use Doctrine\DBAL\Schema\SchemaDiff;
use Doctrine\DBAL\Schema\TableDiff;
use Doctrine\DBAL\Types\Type;
use Symfony\Component\Console\Output\OutputInterface;

class DoctrineSchemaDiffHelper
{
    private $output;
    private $diff;

    public function __construct(OutputInterface $output, SchemaDiff $diff)
    {
        $this->output = $output;
        $this->diff = $diff;
    }

    public function render(): void
    {
        $this->renderRemovedTables();
        $this->output->writeln('');
        $this->renderNewTables();
        $this->output->writeln('');
        $this->renderChangedTables();
    }

    protected function renderRemovedTables(): void

    {
        if (0 === \count($this->diff->removedTables)) {
            return;
        }

        $this->title('Removed tables:');
        $this->listing(array_map(function ($table) { return $table->getName(); }, $this->diff->removedTables));
    }

    protected function renderNewTables(): void

    {
        if (0 === \count($this->diff->newTables)) {
            return;
        }

        $this->title('New tables:');
        $this->listing(array_map(function ($table) { return $table->getName(); }, $this->diff->newTables));
    }

    protected function renderChangedTables(): void
    {
        if (0 === \count($this->diff->changedTables)) {
            return;
        }

        foreach ($this->diff->changedTables as $table) {
            $this->renderChangedTable($table);
        }
    }

    protected function renderChangedTable(TableDiff $tableDiff): void
    {
        $addedColumns = $tableDiff->addedColumns;
        $removedColumns = $tableDiff->removedColumns;
        $changedColumns = $this->filterChangedColumns($tableDiff->changedColumns);

        if (0 === \count($addedColumns + $removedColumns + $changedColumns)) {
            return;
        }

        $this->title("Table \"{$tableDiff->name}\" have been changed:");

        foreach ($addedColumns as $column) {
            $this->renderAddedColumn($column);
        }
        foreach ($removedColumns as $column) {
            $this->renderRemovedColumn($column);
        }

        foreach ($changedColumns as $column) {
            $this->renderChangedColumn($column);
        }
    }

    protected function renderAddedColumn(Column $column): void
    {
        $this->output->writeln('<fg=green> + '.$this->formatColumn($column).'</>');
    }

    protected function renderRemovedColumn(Column $column): void
    {
        $this->output->writeln('<fg=red> - '.$this->formatColumn($column).'</>');
    }

    protected function renderChangedColumn(ColumnDiff $columnDiff): void
    {
        $this->renderRemovedColumn($columnDiff->fromColumn);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $this->renderAddedColumn($columnDiff->column);
    }

    protected function formatColumn(Column $column): string
    {
        $formattedColumn = $column->getName().', '.$column->getType()->getName();

        $options = $this->filterOptions($column);

        if (0 < \count($options)) {
            $formattedOptions = [];
            foreach ($options as $key => $value) {
                $formattedValue = \is_bool($value) ? $value ? 'true' : 'false' : $value;
                $formattedOptions[] = "$key => $formattedValue";
            }

            $formattedColumn .= ', ['.implode(', ', $formattedOptions).']';
        }

        return $formattedColumn;
    }

    public function filterChangedColumns(array $changedColumns): array
    {
        $filteredChangeColumns = [];
        foreach ($changedColumns as $columnDiff) {
            if (['type'] === $columnDiff->changedProperties) {
                // Sometimes it looks like type have been changed but it's not the case
                if ($columnDiff->fromColumn->getType()->getName() === $columnDiff->column->getType()->getName()) {
                    continue;
                }
            }

            $filteredChangeColumns[] = $columnDiff;
        }

        return $filteredChangeColumns;
    }

    protected function filterOptions(Column $column): array
    {
        $options = $column->toArray();
        unset($options['name'], $options['type']);

        $referenceColumn = new Column('tmp', Type::getType($column->getType()->getName()));

        $options = array_filter($options, function ($value, $key) use (&$referenceColumn) {
            $method = 'get'.ucfirst($key);
            // Keep unknown keys
            if (!method_exists($referenceColumn, $method)) {
                return true;
            }

            return $value !== $referenceColumn->$method(); // Ignore default values
        }, ARRAY_FILTER_USE_BOTH);

        return $options;
    }

    protected function title(string $title): void
    {
        $this->output->writeln("<comment>$title</comment>");
    }

    protected function listing(array $elements): void
    {
        $elements = array_map(function ($element) {
            return sprintf(' * %s', $element);
        }, $elements);

        $this->output->writeln($elements);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Shapin\Datagen\Bridge\Symfony\Console\Helper;
6
7			use Doctrine\DBAL\Schema\Column;
8			use Doctrine\DBAL\Schema\ColumnDiff;
9			use Doctrine\DBAL\Schema\SchemaDiff;
10			use Doctrine\DBAL\Schema\TableDiff;
11			use Doctrine\DBAL\Types\Type;
12			use Symfony\Component\Console\Output\OutputInterface;
13
14			class DoctrineSchemaDiffHelper
15			{
16			private $output;
17			private $diff;
18
19	1		public function __construct(OutputInterface $output, SchemaDiff $diff)
20			{
21	1		$this->output = $output;
22	1		$this->diff = $diff;
23	1		}
24
25	1		public function render(): void
26			{
27	1		$this->renderRemovedTables();
28	1		$this->output->writeln('');
29	1		$this->renderNewTables();
30	1		$this->output->writeln('');
31	1		$this->renderChangedTables();
32	1		}
33
34	1	View Code Duplication	protected function renderRemovedTables(): void
			0 ignored issues – show Duplication introduced 2019-09-26 14:07 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...
35			{
36	1		if (0 === \count($this->diff->removedTables)) {
37			return;
38			}
39
40	1		$this->title('Removed tables:');
41			$this->listing(array_map(function ($table) { return $table->getName(); }, $this->diff->removedTables));
42	1		}
43
44	1	View Code Duplication	protected function renderNewTables(): void
			0 ignored issues – show Duplication introduced 2019-09-26 14:07 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...
45			{
46	1		if (0 === \count($this->diff->newTables)) {
47			return;
48			}
49
50	1		$this->title('New tables:');
51			$this->listing(array_map(function ($table) { return $table->getName(); }, $this->diff->newTables));
52	1		}
53
54	1		protected function renderChangedTables(): void
55			{
56	1		if (0 === \count($this->diff->changedTables)) {
57			return;
58			}
59
60	1		foreach ($this->diff->changedTables as $table) {
61	1		$this->renderChangedTable($table);
62			}
63	1		}
64
65	1		protected function renderChangedTable(TableDiff $tableDiff): void
66			{
67	1		$addedColumns = $tableDiff->addedColumns;
68	1		$removedColumns = $tableDiff->removedColumns;
69	1		$changedColumns = $this->filterChangedColumns($tableDiff->changedColumns);
70
71	1		if (0 === \count($addedColumns + $removedColumns + $changedColumns)) {
72			return;
73			}
74
75	1		$this->title("Table \"{$tableDiff->name}\" have been changed:");
76
77	1		foreach ($addedColumns as $column) {
78	1		$this->renderAddedColumn($column);
79			}
80	1		foreach ($removedColumns as $column) {
81	1		$this->renderRemovedColumn($column);
82			}
83
84	1		foreach ($changedColumns as $column) {
85	1		$this->renderChangedColumn($column);
86			}
87	1		}
88
89	1		protected function renderAddedColumn(Column $column): void
90			{
91	1		$this->output->writeln('<fg=green> + '.$this->formatColumn($column).'</>');
92	1		}
93
94	1		protected function renderRemovedColumn(Column $column): void
95			{
96	1		$this->output->writeln('<fg=red> - '.$this->formatColumn($column).'</>');
97	1		}
98
99	1		protected function renderChangedColumn(ColumnDiff $columnDiff): void
100			{
101	1		$this->renderRemovedColumn($columnDiff->fromColumn);
			0 ignored issues – show Bug introduced 2019-11-21 14:07 UTC by Report Bug Copy Issue Report It seems like `$columnDiff->fromColumn` can be `null`; however, `renderRemovedColumn()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
102	1		$this->renderAddedColumn($columnDiff->column);
103	1		}
104
105	1		protected function formatColumn(Column $column): string
106			{
107	1		$formattedColumn = $column->getName().', '.$column->getType()->getName();
108
109	1		$options = $this->filterOptions($column);
110
111	1		if (0 < \count($options)) {
112	1		$formattedOptions = [];
113	1		foreach ($options as $key => $value) {
114	1		$formattedValue = \is_bool($value) ? $value ? 'true' : 'false' : $value;
115	1		$formattedOptions[] = "$key => $formattedValue";
116			}
117
118	1		$formattedColumn .= ', ['.implode(', ', $formattedOptions).']';
119			}
120
121	1		return $formattedColumn;
122			}
123
124	1		public function filterChangedColumns(array $changedColumns): array
125			{
126	1		$filteredChangeColumns = [];
127	1		foreach ($changedColumns as $columnDiff) {
128	1		if (['type'] === $columnDiff->changedProperties) {
129			// Sometimes it looks like type have been changed but it's not the case
130			if ($columnDiff->fromColumn->getType()->getName() === $columnDiff->column->getType()->getName()) {
131			continue;
132			}
133			}
134
135	1		$filteredChangeColumns[] = $columnDiff;
136			}
137
138	1		return $filteredChangeColumns;
139			}
140
141	1		protected function filterOptions(Column $column): array
142			{
143	1		$options = $column->toArray();
144	1		unset($options['name'], $options['type']);
145
146	1		$referenceColumn = new Column('tmp', Type::getType($column->getType()->getName()));
147
148			$options = array_filter($options, function ($value, $key) use (&$referenceColumn) {
149	1		$method = 'get'.ucfirst($key);
150			// Keep unknown keys
151	1		if (!method_exists($referenceColumn, $method)) {
152			return true;
153			}
154
155	1		return $value !== $referenceColumn->$method(); // Ignore default values
156	1		}, ARRAY_FILTER_USE_BOTH);
157
158	1		return $options;
159			}
160
161	1		protected function title(string $title): void
162			{
163	1		$this->output->writeln("<comment>$title</comment>");
164	1		}
165
166	1		protected function listing(array $elements): void
167			{
168			$elements = array_map(function ($element) {
169	1		return sprintf(' * %s', $element);
170	1		}, $elements);
171
172	1		$this->output->writeln($elements);
			0 ignored issues – show Documentation introduced 2019-09-26 14:07 UTC by Report Bug Copy Issue Report `$elements` is of type `array`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
173	1		}
174			}
175

shapintv / datagen

DoctrineSchemaDiffHelper::formatColumn() A last analyzed 2020-12-09 10:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DoctrineSchemaDiffHelper::formatColumn() A
last analyzed 2020-12-09 10:08 UTC