Schematic::importFromYaml() - Code Metrics - Inspection of "Sync tag groups and fix to related field source" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#63)

by Bart

created 2016-06-16 12:02 UTC

Schematic::importFromYaml() A

↳ Parent: Schematic

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	11
rs	9.4285
ccs	7
cts	7
cp	1
cc	1
eloc	7
nc	1
nop	3
crap	1

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft\Craft;
use Craft\BaseApplicationComponent as BaseApplication;
use Craft\IOHelper;
use NerdsAndCompany\Schematic\Models\Data;
use NerdsAndCompany\Schematic\Models\Result;

/**
 * Schematic Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2016, Nerds & Company
 * @license   MIT
 *
 * @link      http://www.nerds.company
 */
class Schematic extends BaseApplication
{
    const SCHEMATIC_METHOD_IMPORT = 'import';
    const SCHEMATIC_METHOD_EXPORT = 'export';

    /**
     * Returns data from import model or default.
     *
     * @param array  $data
     * @param string $handle
     * @param array  $default
     *
     * @return array
     */
    private function getPluginData(array $data, $handle, array $default = [])
    {
        return (array_key_exists($handle, $data) && !is_null($data[$handle])) ? $data[$handle] : $default;
    }

    /**
     * Import from Yaml file.
     *
     * @param string $file
     * @param string $override
     * @param bool   $force    if set to true items not included in import will be deleted
     *
     * @return Result
     */
    public function importFromYaml($file, $override = null, $force = false)
    {
        Craft::app()->config->maxPowerCaptain();
        Craft::app()->setComponent('userSession', $this);

        $yaml = IOHelper::getFileContents($file);
        $yaml_override = IOHelper::getFileContents($override);
        $dataModel = Data::fromYaml($yaml, $yaml_override);

        return $this->importDataModel($dataModel, $force);
    }

    /**
     * Export to Yaml file.
     *
     * @param string $file
     * @param bool   $autoCreate
     *
     * @return Result
     */
    public function exportToYaml($file, $autoCreate = true)
    {
        Craft::app()->config->maxPowerCaptain();
        Craft::app()->setComponent('userSession', $this);

        $result = new Result();
        $dataModel = $this->exportDataModel();
        $yaml = Data::toYaml($dataModel);

        if (!IOHelper::writeToFile($file, $yaml, $autoCreate)) { // Do not auto create
            $result->addError('errors', "Failed to write contents to \"$file\"");
        }

        return $result;
    }

    /**
     * Import data model.
     *
     * @param Data $model
     * @param bool $force if set to true items not in the import will be deleted
     *
     * @return Result
     */
    private function importDataModel(Data $model, $force)
    {
        // Import schema
        $localesImportResult = Craft::app()->schematic_locales->import($model->getAttribute('locales', $force));
        $pluginImportResult = Craft::app()->schematic_plugins->import($model->getAttribute('plugins', $force));
        $fieldImportResult = Craft::app()->schematic_fields->import($model->getAttribute('fields'), $force);
        $assetSourcesImportResult = Craft::app()->schematic_assetSources->import($model->getAttribute('assetSources'), $force);
        $globalSetsImportResult = Craft::app()->schematic_globalSets->import($model->getAttribute('globalSets'), $force);
        $sectionImportResult = Craft::app()->schematic_sections->import($model->getAttribute('sections'), $force);
        $categoryGroupImportResult = Craft::app()->schematic_categoryGroups->import($model->getAttribute('categoryGroups'), $force);
        $tagGroupImportResult = Craft::app()->schematic_tagGroups->import($model->getAttribute('tagGroups'), $force);
        $userGroupImportResult = Craft::app()->schematic_userGroups->import($model->getAttribute('userGroups'), $force);
        $userImportResult = Craft::app()->schematic_users->import($model->getAttribute('users'), true);
        $fieldImportResultFinal = Craft::app()->schematic_fields->import($model->getAttribute('fields'), $force);

        // Element index settings are supported from Craft 2.5
        if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
            $elementIndexSettingsImportResult = Craft::app()->schematic_elementIndexSettings->import($model->getAttribute('elementIndexSettings'), $force);
        }

        // Verify results
        $result = new Result();
        $result->consume($localesImportResult);
        $result->consume($pluginImportResult);
        $result->consume($fieldImportResult);
        $result->consume($assetSourcesImportResult);
        $result->consume($globalSetsImportResult);
        $result->consume($sectionImportResult);
        $result->consume($categoryGroupImportResult);
        $result->consume($tagGroupImportResult);
        $result->consume($userGroupImportResult);
        $result->consume($userImportResult);
        $result->consume($fieldImportResultFinal);

        // Element index settings are supported from Craft 2.5
        if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
            $result->consume($elementIndexSettingsImportResult);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

        $services = Craft::app()->plugins->call('registerMigrationService');
        $this->doImport($result, $model->pluginData, $services, $force);

        return $result;
    }

    /**
     * Handles importing.
     *
     * @param Result       $result
     * @param array        $data
     * @param array|Base[] $services
     * @param bool         $force
     */
    private function doImport(Result $result, array $data, $services, $force)
    {
        foreach ($services as $handle => $service) {
            if (is_array($service)) {
                $this->doImport($result, $data, $service, $force);
            } elseif ($service instanceof Base) {
                $pluginData = $this->getPluginData($data, $handle);
                $hookResult = $service->import($pluginData, $force);
                $result->consume($hookResult);
            }
        }
    }

    /**
     * Export data model.
     *
     * @return array
     */
    private function exportDataModel()
    {
        $fieldGroups = Craft::app()->fields->getAllGroups();
        $sections = Craft::app()->sections->getAllSections();
        $globals = Craft::app()->globals->getAllSets();
        $userGroups = Craft::app()->userGroups->getAllGroups();
        $categoryGroups = Craft::app()->categories->getAllGroups();
        $tagGroups = Craft::app()->tags->getAllTagGroups();

        $export = [
            'locales' => Craft::app()->schematic_locales->export(),
            'assetSources' => Craft::app()->schematic_assetSources->export(),
            'fields' => Craft::app()->schematic_fields->export($fieldGroups),
            'plugins' => Craft::app()->schematic_plugins->export(),
            'sections' => Craft::app()->schematic_sections->export($sections),
            'globalSets' => Craft::app()->schematic_globalSets->export($globals),
            'userGroups' => Craft::app()->schematic_userGroups->export($userGroups),
            'users' => Craft::app()->schematic_users->export(),
            'categoryGroups' => Craft::app()->schematic_categoryGroups->export($categoryGroups),
            'tagGroups' => Craft::app()->schematic_tagGroups->export($tagGroups),
        ];

        // Element index settings are supported from Craft 2.5
        if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
            $export['elementIndexSettings'] = Craft::app()->schematic_elementIndexSettings->export();
        }

        $export['pluginData'] = [];
        $services = Craft::app()->plugins->call('registerMigrationService');
        $this->doExport($services, $export['pluginData']);

        return $export;
    }

    /**
     * Handles exporting.
     *
     * @param array $services
     * @param array $data
     */
    private function doExport(array $services, array &$data)
    {
        foreach ($services as $handle => $service) {
            if (is_array($service)) {
                $this->doExport($service, $data);
            } elseif ($service instanceof Base) {
                if ($service instanceof Base) {
                    $data[$handle] = $service->export();
                }
            }
        }
    }

    /**
     * Assume schematic can do anything.
     *
     * @return bool
     */
    public function checkPermission()
    {
        return true;
    }
}


1		<?php
2
3		namespace NerdsAndCompany\Schematic\Services;
4
5		use Craft\Craft;
6		use Craft\BaseApplicationComponent as BaseApplication;
7		use Craft\IOHelper;
8		use NerdsAndCompany\Schematic\Models\Data;
9		use NerdsAndCompany\Schematic\Models\Result;
10
11		/**
12		* Schematic Service.
13		*
14		* Sync Craft Setups.
15		*
16		* @author Nerds & Company
17		* @copyright Copyright (c) 2015-2016, Nerds & Company
18		* @license MIT
19		*
20		* @link http://www.nerds.company
21		*/
22		class Schematic extends BaseApplication
23		{
24		const SCHEMATIC_METHOD_IMPORT = 'import';
25		const SCHEMATIC_METHOD_EXPORT = 'export';
26
27		/**
28		* Returns data from import model or default.
29		*
30		* @param array $data
31		* @param string $handle
32		* @param array $default
33		*
34		* @return array
35		*/
36		private function getPluginData(array $data, $handle, array $default = [])
37		{
38		return (array_key_exists($handle, $data) && !is_null($data[$handle])) ? $data[$handle] : $default;
39		}
40
41		/**
42		* Import from Yaml file.
43		*
44		* @param string $file
45		* @param string $override
46		* @param bool $force if set to true items not included in import will be deleted
47		*
48		* @return Result
49		*/
50	1	public function importFromYaml($file, $override = null, $force = false)
51		{
52	1	Craft::app()->config->maxPowerCaptain();
53	1	Craft::app()->setComponent('userSession', $this);
54
55	1	$yaml = IOHelper::getFileContents($file);
56	1	$yaml_override = IOHelper::getFileContents($override);
57	1	$dataModel = Data::fromYaml($yaml, $yaml_override);
58
59	1	return $this->importDataModel($dataModel, $force);
60		}
61
62		/**
63		* Export to Yaml file.
64		*
65		* @param string $file
66		* @param bool $autoCreate
67		*
68		* @return Result
69		*/
70	2	public function exportToYaml($file, $autoCreate = true)
71		{
72	2	Craft::app()->config->maxPowerCaptain();
73	2	Craft::app()->setComponent('userSession', $this);
74
75	2	$result = new Result();
76	2	$dataModel = $this->exportDataModel();
77		$yaml = Data::toYaml($dataModel);
78
79		if (!IOHelper::writeToFile($file, $yaml, $autoCreate)) { // Do not auto create
80		$result->addError('errors', "Failed to write contents to \"$file\"");
81		}
82
83		return $result;
84		}
85
86		/**
87		* Import data model.
88		*
89		* @param Data $model
90		* @param bool $force if set to true items not in the import will be deleted
91		*
92		* @return Result
93		*/
94	1	private function importDataModel(Data $model, $force)
95		{
96		// Import schema
97	1	$localesImportResult = Craft::app()->schematic_locales->import($model->getAttribute('locales', $force));
98	1	$pluginImportResult = Craft::app()->schematic_plugins->import($model->getAttribute('plugins', $force));
99	1	$fieldImportResult = Craft::app()->schematic_fields->import($model->getAttribute('fields'), $force);
100	1	$assetSourcesImportResult = Craft::app()->schematic_assetSources->import($model->getAttribute('assetSources'), $force);
101	1	$globalSetsImportResult = Craft::app()->schematic_globalSets->import($model->getAttribute('globalSets'), $force);
102	1	$sectionImportResult = Craft::app()->schematic_sections->import($model->getAttribute('sections'), $force);
103	1	$categoryGroupImportResult = Craft::app()->schematic_categoryGroups->import($model->getAttribute('categoryGroups'), $force);
104	1	$tagGroupImportResult = Craft::app()->schematic_tagGroups->import($model->getAttribute('tagGroups'), $force);
105		$userGroupImportResult = Craft::app()->schematic_userGroups->import($model->getAttribute('userGroups'), $force);
106		$userImportResult = Craft::app()->schematic_users->import($model->getAttribute('users'), true);
107		$fieldImportResultFinal = Craft::app()->schematic_fields->import($model->getAttribute('fields'), $force);
108
109		// Element index settings are supported from Craft 2.5
110		if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
111		$elementIndexSettingsImportResult = Craft::app()->schematic_elementIndexSettings->import($model->getAttribute('elementIndexSettings'), $force);
112		}
113
114		// Verify results
115		$result = new Result();
116		$result->consume($localesImportResult);
117		$result->consume($pluginImportResult);
118		$result->consume($fieldImportResult);
119		$result->consume($assetSourcesImportResult);
120		$result->consume($globalSetsImportResult);
121		$result->consume($sectionImportResult);
122		$result->consume($categoryGroupImportResult);
123		$result->consume($tagGroupImportResult);
124		$result->consume($userGroupImportResult);
125		$result->consume($userImportResult);
126		$result->consume($fieldImportResultFinal);
127
128		// Element index settings are supported from Craft 2.5
129		if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
130		$result->consume($elementIndexSettingsImportResult);
		0 ignored issues – show Bug introduced 2016-01-28 19:31 UTC by Report Bug Copy Issue Report The variable `$elementIndexSettingsImportResult` 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...
131		}
132
133		$services = Craft::app()->plugins->call('registerMigrationService');
134		$this->doImport($result, $model->pluginData, $services, $force);
135
136		return $result;
137		}
138
139		/**
140		* Handles importing.
141		*
142		* @param Result $result
143		* @param array $data
144		* @param array\|Base[] $services
145		* @param bool $force
146		*/
147		private function doImport(Result $result, array $data, $services, $force)
148		{
149		foreach ($services as $handle => $service) {
150		if (is_array($service)) {
151		$this->doImport($result, $data, $service, $force);
152		} elseif ($service instanceof Base) {
153		$pluginData = $this->getPluginData($data, $handle);
154		$hookResult = $service->import($pluginData, $force);
155		$result->consume($hookResult);
156		}
157		}
158		}
159
160		/**
161		* Export data model.
162		*
163		* @return array
164		*/
165	2	private function exportDataModel()
166		{
167	2	$fieldGroups = Craft::app()->fields->getAllGroups();
168	2	$sections = Craft::app()->sections->getAllSections();
169	2	$globals = Craft::app()->globals->getAllSets();
170	2	$userGroups = Craft::app()->userGroups->getAllGroups();
171	2	$categoryGroups = Craft::app()->categories->getAllGroups();
172	2	$tagGroups = Craft::app()->tags->getAllTagGroups();
173
174		$export = [
175		'locales' => Craft::app()->schematic_locales->export(),
176		'assetSources' => Craft::app()->schematic_assetSources->export(),
177		'fields' => Craft::app()->schematic_fields->export($fieldGroups),
178		'plugins' => Craft::app()->schematic_plugins->export(),
179		'sections' => Craft::app()->schematic_sections->export($sections),
180		'globalSets' => Craft::app()->schematic_globalSets->export($globals),
181		'userGroups' => Craft::app()->schematic_userGroups->export($userGroups),
182		'users' => Craft::app()->schematic_users->export(),
183		'categoryGroups' => Craft::app()->schematic_categoryGroups->export($categoryGroups),
184		'tagGroups' => Craft::app()->schematic_tagGroups->export($tagGroups),
185		];
186
187		// Element index settings are supported from Craft 2.5
188		if (version_compare(CRAFT_VERSION, '2.5', '>=')) {
189		$export['elementIndexSettings'] = Craft::app()->schematic_elementIndexSettings->export();
190		}
191
192		$export['pluginData'] = [];
193		$services = Craft::app()->plugins->call('registerMigrationService');
194		$this->doExport($services, $export['pluginData']);
195
196		return $export;
197		}
198
199		/**
200		* Handles exporting.
201		*
202		* @param array $services
203		* @param array $data
204		*/
205		private function doExport(array $services, array &$data)
206		{
207		foreach ($services as $handle => $service) {
208		if (is_array($service)) {
209		$this->doExport($service, $data);
210		} elseif ($service instanceof Base) {
211		if ($service instanceof Base) {
212		$data[$handle] = $service->export();
213		}
214		}
215		}
216		}
217
218		/**
219		* Assume schematic can do anything.
220		*
221		* @return bool
222		*/
223		public function checkPermission()
224		{
225		return true;
226		}
227		}
228

nerds-and-company / schematic

Pull Request — master (#63)

Schematic::importFromYaml() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like