ImportController::importFromYaml() - Code Metrics - Inspection of "Merge pull request #167 from Moskydesign/store-set..." - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a3a102...0d148f )

by Bart

created 2019-02-10 12:48 UTC

ImportController::importFromYaml() C

↳ Parent: ImportController

Complexity

Conditions	12
Paths	48

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	156

Importance

Changes

Metric	Value
dl	0
loc	66
ccs	0
cts	50
cp	0
rs	6.3151
c	0
b	0
f	0
cc	12
nc	48
nop	1
crap	156

How to fix Long Method Complexity

<?php

namespace NerdsAndCompany\Schematic\Controllers;

use Craft;
use NerdsAndCompany\Schematic\Models\Data;
use NerdsAndCompany\Schematic\Schematic;
use craft\errors\WrongEditionException;

/**
 * Schematic Import Command.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class ImportController extends Base
{
    public $force = false;

    /**
     * {@inheritdoc}
     *
     * @return array
     */
    public function options($actionID): array
    {
        return array_merge(parent::options($actionID), ['force']);
    }

    /**
     * Imports the Craft datamodel.
     *
     * @return int
     * @throws \Exception
     */
    public function actionIndex(): int
    {
        if (!file_exists($this->path)) {
            Schematic::error('Directory not found: ' . $this->path);

            return 1;
        }

        $dataTypes = $this->getDataTypes();
        $this->importFromYaml($dataTypes);
        Schematic::info('Loaded schema from '.$this->path);

        return 0;
    }

    /**
     * Import from Yaml file.
     *
     * @param array $dataTypes The data types to import
     * @throws \Exception
     */
    private function importFromYaml(array $dataTypes)
    {
        $this->disableLogging();

        // Parse data in the overrideFile if available.
        $overrideData = Data::parseYamlFile($this->overrideFile);

        // Import from single file.
        if ($this->getStorageType() === self::SINGLE_FILE) {
            $yaml = file_get_contents($this->file);
            $yamlOverride = null;
            if (file_exists($this->overrideFile)) {
                $yamlOverride = file_get_contents($this->overrideFile);
            }
            $definitions = Data::fromYaml($yaml, $yamlOverride);

        }

        // Import from multiple files.
        if ($this->getStorageType() === self::MULTIPLE_FILES) {
            // Grab all yaml files in the schema directory.
            $schemaFiles = preg_grep('~\.(yml)$~', scandir($this->path));

            // Read contents of each file and add it to the definitions.
            foreach ($schemaFiles as $fileName) {
                $schemaStructure = explode('.', $this->fromSafeFileName($fileName));
                $dataTypeHandle = $schemaStructure[0];
                $recordName = $schemaStructure[1];

                $definition = Data::fromYaml(file_get_contents($this->path . $fileName));

                // Check if there is data in the override file for the current record.
                if (isset($overrideData[$dataTypeHandle][$recordName])) {
                    $definition = array_replace_recursive(
                        $definition,
                        $overrideData[$dataTypeHandle][$recordName]
                    );
                }

                $definitions[$dataTypeHandle][$recordName] = $definition;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            }
        }

        foreach ($dataTypes as $dataTypeHandle) {
            $dataType = $this->module->getDataType($dataTypeHandle);
            if (null == $dataType) {
                continue;
            }

            $mapper = $dataType->getMapperHandle();
            if (!$this->module->checkMapper($mapper)) {
                continue;
            }

            Schematic::info('Importing '.$dataTypeHandle);
            Schematic::$force = $this->force;
            if (array_key_exists($dataTypeHandle, $definitions) && is_array($definitions[$dataTypeHandle])) {
                $records = $dataType->getRecords();
                try {
                    $this->module->$mapper->import($definitions[$dataTypeHandle], $records);
                    $dataType->afterImport();
                } catch (WrongEditionException $e) {
                    Schematic::error('Craft Pro is required for datatype '.$dataTypeHandle);
                }
            }
        }
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Controllers;
4
5			use Craft;
6			use NerdsAndCompany\Schematic\Models\Data;
7			use NerdsAndCompany\Schematic\Schematic;
8			use craft\errors\WrongEditionException;
9
10			/**
11			* Schematic Import Command.
12			*
13			* Sync Craft Setups.
14			*
15			* @author Nerds & Company
16			* @copyright Copyright (c) 2015-2018, Nerds & Company
17			* @license MIT
18			*
19			* @see http://www.nerds.company
20			*/
21			class ImportController extends Base
22			{
23			public $force = false;
24
25			/**
26			* {@inheritdoc}
27			*
28			* @return array
29			*/
30			public function options($actionID): array
31			{
32			return array_merge(parent::options($actionID), ['force']);
33			}
34
35			/**
36			* Imports the Craft datamodel.
37			*
38			* @return int
39			* @throws \Exception
40			*/
41			public function actionIndex(): int
42			{
43			if (!file_exists($this->path)) {
44			Schematic::error('Directory not found: ' . $this->path);
45
46			return 1;
47			}
48
49			$dataTypes = $this->getDataTypes();
50			$this->importFromYaml($dataTypes);
51			Schematic::info('Loaded schema from '.$this->path);
52
53			return 0;
54			}
55
56			/**
57			* Import from Yaml file.
58			*
59			* @param array $dataTypes The data types to import
60			* @throws \Exception
61			*/
62			private function importFromYaml(array $dataTypes)
63			{
64			$this->disableLogging();
65
66			// Parse data in the overrideFile if available.
67			$overrideData = Data::parseYamlFile($this->overrideFile);
68
69			// Import from single file.
70			if ($this->getStorageType() === self::SINGLE_FILE) {
71			$yaml = file_get_contents($this->file);
72			$yamlOverride = null;
73			if (file_exists($this->overrideFile)) {
74			$yamlOverride = file_get_contents($this->overrideFile);
75			}
76			$definitions = Data::fromYaml($yaml, $yamlOverride);
			0 ignored issues – show Unused Code introduced 2019-01-14 07:26 UTC by Report Bug Copy Issue Report The call to `Data::fromYaml()` has too many arguments starting with `$yamlOverride`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
77			}
78
79			// Import from multiple files.
80			if ($this->getStorageType() === self::MULTIPLE_FILES) {
81			// Grab all yaml files in the schema directory.
82			$schemaFiles = preg_grep('~\.(yml)$~', scandir($this->path));
83
84			// Read contents of each file and add it to the definitions.
85			foreach ($schemaFiles as $fileName) {
86			$schemaStructure = explode('.', $this->fromSafeFileName($fileName));
87			$dataTypeHandle = $schemaStructure[0];
88			$recordName = $schemaStructure[1];
89
90			$definition = Data::fromYaml(file_get_contents($this->path . $fileName));
91
92			// Check if there is data in the override file for the current record.
93			if (isset($overrideData[$dataTypeHandle][$recordName])) {
94			$definition = array_replace_recursive(
95			$definition,
96			$overrideData[$dataTypeHandle][$recordName]
97			);
98			}
99
100			$definitions[$dataTypeHandle][$recordName] = $definition;
			0 ignored issues – show Bug introduced 2019-01-14 07:26 UTC by Report Bug Copy Issue Report The variable `$definitions` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
101			}
102			}
103
104			foreach ($dataTypes as $dataTypeHandle) {
105			$dataType = $this->module->getDataType($dataTypeHandle);
106			if (null == $dataType) {
107			continue;
108			}
109
110			$mapper = $dataType->getMapperHandle();
111			if (!$this->module->checkMapper($mapper)) {
112			continue;
113			}
114
115			Schematic::info('Importing '.$dataTypeHandle);
116			Schematic::$force = $this->force;
117			if (array_key_exists($dataTypeHandle, $definitions) && is_array($definitions[$dataTypeHandle])) {
118			$records = $dataType->getRecords();
119			try {
120			$this->module->$mapper->import($definitions[$dataTypeHandle], $records);
121			$dataType->afterImport();
122			} catch (WrongEditionException $e) {
123			Schematic::error('Craft Pro is required for datatype '.$dataTypeHandle);
124			}
125			}
126			}
127			}
128			}
129

nerds-and-company / schematic

Push — master ( a3a102...0d148f )

ImportController::importFromYaml() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like