ImportConfigDiffCommand::configure() - Code Metrics - Inspection of "Pac 694 diff command" - techdivision/import-cli - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#17)

unknown

created 2023-07-10 11:45 UTC

ImportConfigDiffCommand::configure() A

↳ Parent: ImportConfigDiffCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	8
rs	10
c	1
b	0
f	1

<?php
/**
 * TechDivision\Import\Cli\Command\ImportConfigDiffCommand
 *
 * PHP version 7
 *
 * @author    [email protected]
 * @copyright 2023 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-cli-simple
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Cli\Command;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use TechDivision\Import\Configuration\ConfigurationInterface;
use TechDivision\Import\Utils\CommandNames;

/**
 * The import command implementation.
 *
 * @author    [email protected]
 * @copyright 2023 TechDivision GmbH <[email protected]>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import-cli-simple
 * @link      http://www.techdivision.com
 */
class ImportConfigDiffCommand extends AbstractSimpleImportCommand
{
    /**
     * file where default values are saved
     *
     * @var string
     */
    public const DEFAULT_FILE = __DIR__ . '/../../config.json.default';

    /** @var string */
    public const ADD_KEY = 'added';

    /** @var string */
    public const DELETE_KEY = 'deleted';

    /** @var string */
    public const CHANGED_KEY = 'changed';

    /**
     * Configures the current command.
     *
     * @return void
     * @see \Symfony\Component\Console\Command\Command::configure()
     */
    protected function configure(): void
    {
        // initialize the command with the required/optional options
        $this->setName(CommandNames::IMPORT_CONFIG_DIFF)

            ->setDescription('Shows Diffs between default configuration values and project config');

        // invoke the parent method
        parent::configure();
    }

    /**
     * Finally executes the simple command.
     *
     * @param ConfigurationInterface $configuration The configuration instance
     * @param InputInterface         $input         An InputInterface instance
     * @param OutputInterface        $output        An OutputInterface instance
     *
     * @return int
     */
    protected function executeSimpleCommand(
        ConfigurationInterface $configuration,
        InputInterface $input,
        OutputInterface $output
    ): int {
        $serializer = $this->createSerializer();
        $projectValues = $serializer->serialize($configuration, 'json');
        $defaultValues = file_get_contents(self::DEFAULT_FILE);

        // compare project and default Values
        if ($defaultValues !== $projectValues) {
            $projectJsonValues = json_decode($projectValues);
            $defaultValuesJson = json_decode($defaultValues);
            $paths = $this->getDataAsFlatArray($projectJsonValues);
            $defaultPaths = $this->getDataAsFlatArray($defaultValuesJson);
            $diff = $this->getAllDiffs($defaultPaths, $paths);
            $this->writeDiffs($defaultPaths, $paths, $diff, $output);
            return 0;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        $output->writeln('[*] no changes found');
        return 0;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * @param array $defaultPaths Default values as flat array
     * @param array $paths        Project values as flat array
     * @return array
     */
    public function getAllDiffs(array $defaultPaths, array $paths): array
    {
        $addedKeys = $this->getAddedKeys($defaultPaths, $paths);
        $manipulatedKeys = array_diff_assoc($defaultPaths, $paths);
        $deletedKeys = $this->getDeletedKeys($defaultPaths, $paths);
        return [
            self::ADD_KEY => $addedKeys,
            self::DELETE_KEY => $deletedKeys,
            self::CHANGED_KEY => $manipulatedKeys,
        ];
    }

    /**
     * @param array           $defaultConfig Default values as flat array
     * @param array           $projectConfig Project values as flat array
     * @param array           $diff          Array with all diffs
     * @param OutputInterface $output        OutputInterface instance
     * @return void
     */
    private function writeDiffs(
        array $defaultConfig,
        array $projectConfig,
        array $diff,
        OutputInterface $output
    ): void {
        $output->writeln('Original | Override');
        foreach ($diff[self::DELETE_KEY] as $deletedKey) {
            $output->writeln($deletedKey . ':' .
                '"' . $defaultConfig[$deletedKey] . '"' . ' | --- key was deleted ---');
        }
        foreach ($diff[self::ADD_KEY] as $addedKey) {
            $output->writeln('--- key was added --- | ' . $addedKey . ':' .
                '"' . $projectConfig[$addedKey] . '"');
        }
        foreach ($diff[self::CHANGED_KEY] as $key => $value) {
            $output->writeln($key. ':' .
                '"'.$defaultConfig[$key].'"' . ' | ' . $key . ':'. '"'.$projectConfig[$key].'"');
        }
    }

    /**
     * @param array $default Default values as flat array
     * @param array $project Project values as flat array
     * @return array
     */
    private function getDeletedKeys(array $default, array $project): array
    {
        $deletedKeys = [];
        foreach ($default as $key => $value) {
            if (!array_key_exists($key, $project)) {
                $deletedKeys[] = $key;
            }
        }
        return $deletedKeys;
    }

    /**
     * @param array $default Default values as flat array
     * @param array $project Project values as flat array
     * @return array
     */
    private function getAddedKeys(array $default, array $project): array
    {
        $addedKeys = [];
        foreach ($project as $key => $value) {
            if (!array_key_exists($key, $default)) {
                $addedKeys[] = $key;
            }
        }
        return $addedKeys;
    }

    /**
     * @param mixd   $data Data to be converted to flat array
filter:
    dependency_paths: ["lib/*"]
     * @param string $key  Key of the data
     * @param string $path Path of the data
     * @param array  $arr  Array to be filled with data
     * @return array
     */
    public function getDataAsFlatArray($data, string $key = '', string $path = '', array $arr = []): array
    {
        if ($path != '') {
            $path = $path . '/';
        }
        $path = $path . $key;
        if (is_object($data) || is_array($data)) {
            foreach ($data as $key => $value) {
                $arr = $this->getDataAsFlatArray($value, $key, $path, $arr);
            }
        } else {
            $arr[$path] = $data;
        }
        return $arr;
    }
}


1			<?php
2			/**
3			* TechDivision\Import\Cli\Command\ImportConfigDiffCommand
4			*
5			* PHP version 7
6			*
7			* @author [email protected]
8			* @copyright 2023 TechDivision GmbH <[email protected]>
9			* @license https://opensource.org/licenses/MIT
10			* @link https://github.com/techdivision/import-cli-simple
11			* @link http://www.techdivision.com
12			*/
13
14			namespace TechDivision\Import\Cli\Command;
15
16			use Symfony\Component\Console\Input\InputInterface;
17			use Symfony\Component\Console\Output\OutputInterface;
18			use TechDivision\Import\Configuration\ConfigurationInterface;
19			use TechDivision\Import\Utils\CommandNames;
20
21			/**
22			* The import command implementation.
23			*
24			* @author [email protected]
25			* @copyright 2023 TechDivision GmbH <[email protected]>
26			* @license https://opensource.org/licenses/MIT
27			* @link https://github.com/techdivision/import-cli-simple
28			* @link http://www.techdivision.com
29			*/
30			class ImportConfigDiffCommand extends AbstractSimpleImportCommand
31			{
32			/**
33			* file where default values are saved
34			*
35			* @var string
36			*/
37			public const DEFAULT_FILE = __DIR__ . '/../../config.json.default';
38
39			/** @var string */
40			public const ADD_KEY = 'added';
41
42			/** @var string */
43			public const DELETE_KEY = 'deleted';
44
45			/** @var string */
46			public const CHANGED_KEY = 'changed';
47
48			/**
49			* Configures the current command.
50			*
51			* @return void
52			* @see \Symfony\Component\Console\Command\Command::configure()
53			*/
54			protected function configure(): void
55			{
56			// initialize the command with the required/optional options
57			$this->setName(CommandNames::IMPORT_CONFIG_DIFF)
			0 ignored issues – show Bug introduced 2023-07-10 10:25 UTC by Report Bug Copy Issue Report The constant `TechDivision\Import\Util...mes::IMPORT_CONFIG_DIFF` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
58			->setDescription('Shows Diffs between default configuration values and project config');
59
60			// invoke the parent method
61			parent::configure();
62			}
63
64			/**
65			* Finally executes the simple command.
66			*
67			* @param ConfigurationInterface $configuration The configuration instance
68			* @param InputInterface $input An InputInterface instance
69			* @param OutputInterface $output An OutputInterface instance
70			*
71			* @return int
72			*/
73			protected function executeSimpleCommand(
74			ConfigurationInterface $configuration,
75			InputInterface $input,
76			OutputInterface $output
77			): int {
78			$serializer = $this->createSerializer();
79			$projectValues = $serializer->serialize($configuration, 'json');
80			$defaultValues = file_get_contents(self::DEFAULT_FILE);
81
82			// compare project and default Values
83			if ($defaultValues !== $projectValues) {
84			$projectJsonValues = json_decode($projectValues);
85			$defaultValuesJson = json_decode($defaultValues);
86			$paths = $this->getDataAsFlatArray($projectJsonValues);
87			$defaultPaths = $this->getDataAsFlatArray($defaultValuesJson);
88			$diff = $this->getAllDiffs($defaultPaths, $paths);
89			$this->writeDiffs($defaultPaths, $paths, $diff, $output);
90			return 0;
			0 ignored issues – show Bug Best Practice introduced 2023-07-10 10:25 UTC by Report Bug Copy Issue Report The expression `return 0` returns the type `integer` which is incompatible with the return type mandated by `TechDivision\Import\Cli\...:executeSimpleCommand()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
91			}
92
93			$output->writeln('[*] no changes found');
94			return 0;
			0 ignored issues – show Bug Best Practice introduced 2023-07-10 10:25 UTC by Report Bug Copy Issue Report The expression `return 0` returns the type `integer` which is incompatible with the return type mandated by `TechDivision\Import\Cli\...:executeSimpleCommand()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
95			}
96
97			/**
98			* @param array $defaultPaths Default values as flat array
99			* @param array $paths Project values as flat array
100			* @return array
101			*/
102			public function getAllDiffs(array $defaultPaths, array $paths): array
103			{
104			$addedKeys = $this->getAddedKeys($defaultPaths, $paths);
105			$manipulatedKeys = array_diff_assoc($defaultPaths, $paths);
106			$deletedKeys = $this->getDeletedKeys($defaultPaths, $paths);
107			return [
108			self::ADD_KEY => $addedKeys,
109			self::DELETE_KEY => $deletedKeys,
110			self::CHANGED_KEY => $manipulatedKeys,
111			];
112			}
113
114			/**
115			* @param array $defaultConfig Default values as flat array
116			* @param array $projectConfig Project values as flat array
117			* @param array $diff Array with all diffs
118			* @param OutputInterface $output OutputInterface instance
119			* @return void
120			*/
121			private function writeDiffs(
122			array $defaultConfig,
123			array $projectConfig,
124			array $diff,
125			OutputInterface $output
126			): void {
127			$output->writeln('Original \| Override');
128			foreach ($diff[self::DELETE_KEY] as $deletedKey) {
129			$output->writeln($deletedKey . ':' .
130			'"' . $defaultConfig[$deletedKey] . '"' . ' \| --- key was deleted ---');
131			}
132			foreach ($diff[self::ADD_KEY] as $addedKey) {
133			$output->writeln('--- key was added --- \| ' . $addedKey . ':' .
134			'"' . $projectConfig[$addedKey] . '"');
135			}
136			foreach ($diff[self::CHANGED_KEY] as $key => $value) {
137			$output->writeln($key. ':' .
138			'"'.$defaultConfig[$key].'"' . ' \| ' . $key . ':'. '"'.$projectConfig[$key].'"');
139			}
140			}
141
142			/**
143			* @param array $default Default values as flat array
144			* @param array $project Project values as flat array
145			* @return array
146			*/
147			private function getDeletedKeys(array $default, array $project): array
148			{
149			$deletedKeys = [];
150			foreach ($default as $key => $value) {
151			if (!array_key_exists($key, $project)) {
152			$deletedKeys[] = $key;
153			}
154			}
155			return $deletedKeys;
156			}
157
158			/**
159			* @param array $default Default values as flat array
160			* @param array $project Project values as flat array
161			* @return array
162			*/
163			private function getAddedKeys(array $default, array $project): array
164			{
165			$addedKeys = [];
166			foreach ($project as $key => $value) {
167			if (!array_key_exists($key, $default)) {
168			$addedKeys[] = $key;
169			}
170			}
171			return $addedKeys;
172			}
173
174			/**
175			* @param mixd $data Data to be converted to flat array
			0 ignored issues – show Bug introduced 2023-07-10 11:55 UTC by Report Bug Copy Issue Report The type `TechDivision\Import\Cli\Command\mixd` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
176			* @param string $key Key of the data
177			* @param string $path Path of the data
178			* @param array $arr Array to be filled with data
179			* @return array
180			*/
181			public function getDataAsFlatArray($data, string $key = '', string $path = '', array $arr = []): array
182			{
183			if ($path != '') {
184			$path = $path . '/';
185			}
186			$path = $path . $key;
187			if (is_object($data) \|\| is_array($data)) {
188			foreach ($data as $key => $value) {
189			$arr = $this->getDataAsFlatArray($value, $key, $path, $arr);
190			}
191			} else {
192			$arr[$path] = $data;
193			}
194			return $arr;
195			}
196			}
197

techdivision / import-cli

Pull Request — master (#17)

ImportConfigDiffCommand::configure() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like