ReferenceExecutor::load() - Code Metrics - Inspection of "Merge branch 'future-4.x' of github.com:kaliop-uk/..." - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ac3b8b...3c857d )

by Gaetano

created 2017-05-13 23:40 UTC

ReferenceExecutor::load() C

↳ Parent: ReferenceExecutor

Complexity

Conditions	13
Paths	81

Size

Total Lines	49
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	49
c	0
b	0
f	0
rs	5.1401
cc	13
eloc	30
nc	81
nop	2

How to fix Complexity

<?php


namespace Kaliop\eZMigrationBundle\Core\Executor;

use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Yaml\Yaml;
use Symfony\Component\VarDumper\VarDumper;
use Kaliop\eZMigrationBundle\API\Value\MigrationStep;
use Kaliop\eZMigrationBundle\API\ReferenceResolverBagInterface;
use Kaliop\eZMigrationBundle\API\EnumerableReferenceResolverInterface;

class ReferenceExecutor extends AbstractExecutor
{
    protected $supportedStepTypes = array('reference');
    protected $supportedActions = array('set', 'load', 'save', 'dump');

    protected $container;
    /** @var ReferenceResolverBagInterface $referenceResolver */
    protected $referenceResolver;

    public function __construct(ContainerInterface $container, ReferenceResolverBagInterface $referenceResolver)
    {
        $this->container = $container;
        $this->referenceResolver = $referenceResolver;
    }

    /**
     * @param MigrationStep $step
     * @return mixed
     * @throws \Exception
     */
    public function execute(MigrationStep $step)

    {
        parent::execute($step);

        if (!isset($step->dsl['mode'])) {
            throw new \Exception("Invalid step definition: missing 'mode'");
        }

        $action = $step->dsl['mode'];

        if (!in_array($action, $this->supportedActions)) {
            throw new \Exception("Invalid step definition: value '$action' is not allowed for 'mode'");
        }

        return $this->$action($step->dsl, $step->context);
    }

    protected function set($dsl, $context)

    {
        if (!isset($dsl['identifier'])) {
            throw new \Exception("Invalid step definition: miss 'identifier' for setting reference");
        }
        if (!isset($dsl['value'])) {
            throw new \Exception("Invalid step definition: miss 'value' for setting reference");
        }
        $value = $dsl['value'];
        if (preg_match('/%.+%$/', $value)) {
            $value = $this->container->getParameter(trim($value, '%'));
        }
        $overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;
        $this->referenceResolver->addReference($dsl['identifier'], $value, $overwrite);

        return $value;
    }

    protected function load($dsl, $context)
    {
        if (!isset($dsl['file'])) {
            throw new \Exception("Invalid step definition: miss 'file' for loading references");
        }
        $fileName = $dsl['file'];

        $overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;

        $fileName = str_replace('{ENV}', $this->container->get('kernel')->getEnvironment(), $fileName);

        if (!is_file($fileName) && is_file(dirname($context['path']) . '/references/' . $fileName)) {
            $fileName = dirname($context['path']) . '/references/' . $fileName;
        }

        if (!is_file($fileName)) {
            throw new \Exception("Invalid step definition: invalid file '$fileName' for loading references");
        }
        $data = file_get_contents($fileName);

        $ext = pathinfo($dsl['file'], PATHINFO_EXTENSION);
        switch ($ext) {
            case 'json':
                $data = json_decode($data, true);
                break;
            case 'yml':
            case 'yaml':
                $data = Yaml::parse($data);
                break;
            default:
                throw new \Exception("Invalid step definition: unsupported file extension for loading references from");
        }

        if (!is_array($data)) {
            throw new \Exception("Invalid step definition: file does not contain an array of key/value pairs");
        }

        foreach ($data as $refName => $value) {
            if (preg_match('/%.+%$/', $value)) {
                $value = $this->container->getParameter(trim($value, '%'));
            }

            if (!$this->referenceResolver->addReference($refName, $value, $overwrite)) {
                throw new \Exception("Failed adding to Reference Resolver the reference: $refName");
            }
        }

        return $data;
    }

    /**
     * @todo find a smart way to allow saving the references file next to the current migration
     */
    protected function save($dsl, $context)

    {
        if (!isset($dsl['file'])) {
            throw new \Exception("Invalid step definition: miss 'file' for saving references");
        }
        $fileName = $dsl['file'];

        $overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;

        $fileName = str_replace('{ENV}', $this->container->get('kernel')->getEnvironment(), $fileName);

        if (is_file($fileName) && !$overwrite) {
            throw new \Exception("Invalid step definition: file '$fileName' for saving references already exists");
        }

        if (! $this->referenceResolver instanceof EnumerableReferenceResolverInterface) {
            throw new \Exception("Can not save references as resolver is not enumerable");
        }

        $data = $this->referenceResolver->listReferences();

        $ext = pathinfo($fileName, PATHINFO_EXTENSION);
        switch ($ext) {

            case 'json':
                $data = json_encode($data, JSON_PRETTY_PRINT);
                break;
            case 'yml':
            case 'yaml':
                $data = Yaml::dump($data);
                break;
            default:
                throw new \Exception("Invalid step definition: unsupported file extension for saving references to");
        }

        file_put_contents($fileName, $data);

        return $data;
    }

    protected function dump($dsl, $context)

    {
        if (!isset($dsl['identifier'])) {
            throw new \Exception("Invalid step definition: miss 'identifier' for dumping reference");
        }
        if (!$this->referenceResolver->isReference($dsl['identifier'])) {
            throw new \Exception("Invalid step definition: identifier '{$dsl['identifier']}' is not a reference");
        }
        VarDumper::dump($dsl['identifier']);
        $value = $this->referenceResolver->resolveReference($dsl['identifier']);
        VarDumper::dump($value);

        return $value;
    }
}


1		<?php
2
3
4		namespace Kaliop\eZMigrationBundle\Core\Executor;
5
6		use Symfony\Component\DependencyInjection\ContainerInterface;
7		use Symfony\Component\Yaml\Yaml;
8		use Symfony\Component\VarDumper\VarDumper;
9		use Kaliop\eZMigrationBundle\API\Value\MigrationStep;
10		use Kaliop\eZMigrationBundle\API\ReferenceResolverBagInterface;
11		use Kaliop\eZMigrationBundle\API\EnumerableReferenceResolverInterface;
12
13		class ReferenceExecutor extends AbstractExecutor
14		{
15		protected $supportedStepTypes = array('reference');
16		protected $supportedActions = array('set', 'load', 'save', 'dump');
17
18		protected $container;
19		/** @var ReferenceResolverBagInterface $referenceResolver */
20		protected $referenceResolver;
21
22		public function __construct(ContainerInterface $container, ReferenceResolverBagInterface $referenceResolver)
23		{
24		$this->container = $container;
25		$this->referenceResolver = $referenceResolver;
26		}
27
28		/**
29		* @param MigrationStep $step
30		* @return mixed
31		* @throws \Exception
32		*/
33	View Code Duplication	public function execute(MigrationStep $step)
		0 ignored issues – show Duplication introduced 2017-05-13 23:58 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...
34		{
35		parent::execute($step);
36
37		if (!isset($step->dsl['mode'])) {
38		throw new \Exception("Invalid step definition: missing 'mode'");
39		}
40
41		$action = $step->dsl['mode'];
42
43		if (!in_array($action, $this->supportedActions)) {
44		throw new \Exception("Invalid step definition: value '$action' is not allowed for 'mode'");
45		}
46
47		return $this->$action($step->dsl, $step->context);
48		}
49
50		protected function set($dsl, $context)
		0 ignored issues – show Unused Code introduced 2017-02-26 15:35 UTC by Report Bug Copy Issue Report The parameter `$context` 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...
51		{
52		if (!isset($dsl['identifier'])) {
53		throw new \Exception("Invalid step definition: miss 'identifier' for setting reference");
54		}
55		if (!isset($dsl['value'])) {
56		throw new \Exception("Invalid step definition: miss 'value' for setting reference");
57		}
58		$value = $dsl['value'];
59		if (preg_match('/%.+%$/', $value)) {
60		$value = $this->container->getParameter(trim($value, '%'));
61		}
62		$overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;
63		$this->referenceResolver->addReference($dsl['identifier'], $value, $overwrite);
64
65		return $value;
66		}
67
68		protected function load($dsl, $context)
69		{
70		if (!isset($dsl['file'])) {
71		throw new \Exception("Invalid step definition: miss 'file' for loading references");
72		}
73		$fileName = $dsl['file'];
74
75		$overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;
76
77		$fileName = str_replace('{ENV}', $this->container->get('kernel')->getEnvironment(), $fileName);
78
79		if (!is_file($fileName) && is_file(dirname($context['path']) . '/references/' . $fileName)) {
80		$fileName = dirname($context['path']) . '/references/' . $fileName;
81		}
82
83		if (!is_file($fileName)) {
84		throw new \Exception("Invalid step definition: invalid file '$fileName' for loading references");
85		}
86		$data = file_get_contents($fileName);
87
88		$ext = pathinfo($dsl['file'], PATHINFO_EXTENSION);
89		switch ($ext) {
90		case 'json':
91		$data = json_decode($data, true);
92		break;
93		case 'yml':
94		case 'yaml':
95		$data = Yaml::parse($data);
96		break;
97		default:
98		throw new \Exception("Invalid step definition: unsupported file extension for loading references from");
99		}
100
101		if (!is_array($data)) {
102		throw new \Exception("Invalid step definition: file does not contain an array of key/value pairs");
103		}
104
105		foreach ($data as $refName => $value) {
106		if (preg_match('/%.+%$/', $value)) {
107		$value = $this->container->getParameter(trim($value, '%'));
108		}
109
110		if (!$this->referenceResolver->addReference($refName, $value, $overwrite)) {
111		throw new \Exception("Failed adding to Reference Resolver the reference: $refName");
112		}
113		}
114
115		return $data;
116		}
117
118		/**
119		* @todo find a smart way to allow saving the references file next to the current migration
120		*/
121		protected function save($dsl, $context)
		0 ignored issues – show Unused Code introduced 2017-05-13 23:58 UTC by Report Bug Copy Issue Report The parameter `$context` 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...
122		{
123		if (!isset($dsl['file'])) {
124		throw new \Exception("Invalid step definition: miss 'file' for saving references");
125		}
126		$fileName = $dsl['file'];
127
128		$overwrite = isset($dsl['overwrite']) ? $overwrite = $dsl['overwrite'] : false;
129
130		$fileName = str_replace('{ENV}', $this->container->get('kernel')->getEnvironment(), $fileName);
131
132		if (is_file($fileName) && !$overwrite) {
133		throw new \Exception("Invalid step definition: file '$fileName' for saving references already exists");
134		}
135
136		if (! $this->referenceResolver instanceof EnumerableReferenceResolverInterface) {
137		throw new \Exception("Can not save references as resolver is not enumerable");
138		}
139
140		$data = $this->referenceResolver->listReferences();
141
142		$ext = pathinfo($fileName, PATHINFO_EXTENSION);
143	View Code Duplication	switch ($ext) {
		0 ignored issues – show Duplication introduced 2017-05-13 23:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
144		case 'json':
145		$data = json_encode($data, JSON_PRETTY_PRINT);
146		break;
147		case 'yml':
148		case 'yaml':
149		$data = Yaml::dump($data);
150		break;
151		default:
152		throw new \Exception("Invalid step definition: unsupported file extension for saving references to");
153		}
154
155		file_put_contents($fileName, $data);
156
157		return $data;
158		}
159
160		protected function dump($dsl, $context)
		0 ignored issues – show Unused Code introduced 2017-05-13 23:58 UTC by Report Bug Copy Issue Report The parameter `$context` 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...
161		{
162		if (!isset($dsl['identifier'])) {
163		throw new \Exception("Invalid step definition: miss 'identifier' for dumping reference");
164		}
165		if (!$this->referenceResolver->isReference($dsl['identifier'])) {
166		throw new \Exception("Invalid step definition: identifier '{$dsl['identifier']}' is not a reference");
167		}
168		VarDumper::dump($dsl['identifier']);
169		$value = $this->referenceResolver->resolveReference($dsl['identifier']);
170		VarDumper::dump($value);
171
172		return $value;
173		}
174		}
175

kaliop-uk / ezmigrationbundle

Push — master ( ac3b8b...3c857d )

ReferenceExecutor::load() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like