JsonStorage::__construct() - Code Metrics - Inspection of "Merge pull request #51 from webmozart/external-pac..." - puli/manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6343d0...45320b )

by Bernhard

created 2016-02-01 15:37 UTC

JsonStorage::__construct() A

↳ Parent: JsonStorage

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the puli/manager package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Manager\Json;

use Puli\Manager\Api\Config\Config;
use Puli\Manager\Api\Config\ConfigFile;
use Puli\Manager\Api\Factory\FactoryManager;
use Puli\Manager\Api\FileNotFoundException;
use Puli\Manager\Api\InvalidConfigException;
use Puli\Manager\Api\Module\ModuleFile;
use Puli\Manager\Api\Module\RootModuleFile;
use Puli\Manager\Api\Storage\ReadException;
use Puli\Manager\Api\Storage\Storage;
use Puli\Manager\Api\Storage\WriteException;
use stdClass;
use Webmozart\Json\Conversion\ConversionFailedException;
use Webmozart\Json\DecodingFailedException;
use Webmozart\Json\EncodingFailedException;
use Webmozart\Json\JsonDecoder;
use Webmozart\Json\JsonEncoder;

/**
 * Loads and saves JSON files.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class JsonStorage
{
    /**
     * @var Storage
     */
    private $storage;

    /**
     * @var JsonConverterProvider
     */
    private $converterProvider;

    /**
     * @var JsonEncoder
     */
    private $jsonEncoder;

    /**
     * @var JsonDecoder
     */
    private $jsonDecoder;

    /**
     * @var FactoryManager
     */
    private $factoryManager;

    /**
     * Creates a new storage.
     *
     * @param Storage               $storage           The file storage.
     * @param JsonConverterProvider $converterProvider The provider for the JSON
     *                                                 converters.
     * @param JsonEncoder           $jsonEncoder       The JSON encoder.
     * @param JsonDecoder           $jsonDecoder       The JSON decoder.
     * @param FactoryManager|null   $factoryManager    The manager used to
     *                                                 regenerate the factory
     *                                                 class after saving a file.
     */
    public function __construct(
        Storage $storage,
        JsonConverterProvider $converterProvider,
        JsonEncoder $jsonEncoder,
        JsonDecoder $jsonDecoder,
        FactoryManager $factoryManager = null
    ) {
        $this->storage = $storage;
        $this->converterProvider = $converterProvider;
        $this->jsonEncoder = $jsonEncoder;
        $this->jsonDecoder = $jsonDecoder;
        $this->factoryManager = $factoryManager;
    }

    /**
     * Loads a configuration file from a path.
     *
     * @param string      $path       The path to the configuration file.
     * @param Config|null $baseConfig The configuration that the loaded
     *                                configuration will inherit its values
     *                                from.
     *
     * @return ConfigFile The loaded configuration file.
     *
     * @throws FileNotFoundException  If the file does not exist.
     * @throws ReadException          If the file cannot be read.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function loadConfigFile($path, Config $baseConfig = null)
    {
        return $this->loadFile($path, 'Puli\Manager\Api\Config\ConfigFile', array(
            'baseConfig' => $baseConfig,
        ));
    }

    /**
     * Saves a configuration file.
     *
     * The configuration file is saved to the same path that it was read from.
     *
     * @param ConfigFile $configFile The configuration file to save.
     *
     * @throws WriteException         If the file cannot be written.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function saveConfigFile(ConfigFile $configFile)
    {
        $this->saveFile($configFile, $configFile->getPath());

        if ($this->factoryManager) {
            $this->factoryManager->autoGenerateFactoryClass();
        }
    }

    /**
     * Loads a module file from a file path.
     *
     * @param string $path The path to the module file.
     *
     * @return ModuleFile The loaded module file.
     *
     * @throws FileNotFoundException  If the file does not exist.
     * @throws ReadException          If the file cannot be read.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function loadModuleFile($path)
    {
        return $this->loadFile($path, 'Puli\Manager\Api\Module\ModuleFile');
    }

    /**
     * Saves a module file.
     *
     * The module file is saved to the same path that it was read from.
     *
     * @param ModuleFile $moduleFile The module file to save.
     *
     * @throws WriteException         If the file cannot be written.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function saveModuleFile(ModuleFile $moduleFile)
    {
        $this->saveFile($moduleFile, $moduleFile->getPath(), array(
            'targetVersion' => $moduleFile->getVersion(),
        ));
    }

    /**
     * Loads a root module file from a file path.
     *
     * @param string $path       The path to the module configuration file.
     * @param Config $baseConfig The configuration that the module will inherit
     *                           its configuration values from.
     *
     * @return RootModuleFile The loaded module file.
     *
     * @throws FileNotFoundException  If the file does not exist.
     * @throws ReadException          If the file cannot be read.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function loadRootModuleFile($path, Config $baseConfig)
    {
        return $this->loadFile($path, 'Puli\Manager\Api\Module\RootModuleFile', array(
            'baseConfig' => $baseConfig,
        ));
    }

    /**
     * Saves a root module file.
     *
     * The module file is saved to the same path that it was read from.
     *
     * @param RootModuleFile $moduleFile The module file to save.
     *
     * @throws WriteException         If the file cannot be written.
     * @throws InvalidConfigException If the file contains invalid configuration.
     */
    public function saveRootModuleFile(RootModuleFile $moduleFile)
    {
        $this->saveFile($moduleFile, $moduleFile->getPath(), array(
            'targetVersion' => $moduleFile->getVersion(),
        ));

        if ($this->factoryManager) {
            $this->factoryManager->autoGenerateFactoryClass();
        }
    }

    private function loadFile($path, $className, array $options = array())

    {
        $json = $this->storage->read($path);
        $jsonData = $this->decode($json, $path);
        $options['path'] = $path;

        try {
            return $this->converterProvider->getJsonConverter($className)->fromJson($jsonData, $options);
        } catch (ConversionFailedException $e) {
            throw new InvalidConfigException(sprintf(
                'The JSON in %s could not be converted: %s',
                $path,
                $e->getMessage()
            ), 0, $e);
        }
    }

    private function saveFile($file, $path, array $options = array())

    {
        $className = get_class($file);

        try {
            $jsonData = $this->converterProvider->getJsonConverter($className)->toJson($file, $options);
        } catch (ConversionFailedException $e) {
            throw new InvalidConfigException(sprintf(
                'The data written to %s could not be converted: %s',
                $path,
                $e->getMessage()
            ), 0, $e);
        }

        $json = $this->encode($jsonData, $path);

        $this->storage->write($path, $json);
    }

    private function encode(stdClass $jsonData, $path)
    {
        try {
            return $this->jsonEncoder->encode($jsonData);
        } catch (EncodingFailedException $e) {
            throw new InvalidConfigException(sprintf(
                'The configuration in %s could not be encoded: %s',
                $path,
                $e->getMessage()
            ), 0, $e);
        }
    }

    private function decode($json, $path)
    {
        try {
            return $this->jsonDecoder->decode($json);
        } catch (DecodingFailedException $e) {
            throw new InvalidConfigException(sprintf(
                'The configuration in %s could not be decoded: %s',
                $path,
                $e->getMessage()
            ), 0, $e);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/manager package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Puli\Manager\Json;
13
14			use Puli\Manager\Api\Config\Config;
15			use Puli\Manager\Api\Config\ConfigFile;
16			use Puli\Manager\Api\Factory\FactoryManager;
17			use Puli\Manager\Api\FileNotFoundException;
18			use Puli\Manager\Api\InvalidConfigException;
19			use Puli\Manager\Api\Module\ModuleFile;
20			use Puli\Manager\Api\Module\RootModuleFile;
21			use Puli\Manager\Api\Storage\ReadException;
22			use Puli\Manager\Api\Storage\Storage;
23			use Puli\Manager\Api\Storage\WriteException;
24			use stdClass;
25			use Webmozart\Json\Conversion\ConversionFailedException;
26			use Webmozart\Json\DecodingFailedException;
27			use Webmozart\Json\EncodingFailedException;
28			use Webmozart\Json\JsonDecoder;
29			use Webmozart\Json\JsonEncoder;
30
31			/**
32			* Loads and saves JSON files.
33			*
34			* @since 1.0
35			*
36			* @author Bernhard Schussek <[email protected]>
37			*/
38			class JsonStorage
39			{
40			/**
41			* @var Storage
42			*/
43			private $storage;
44
45			/**
46			* @var JsonConverterProvider
47			*/
48			private $converterProvider;
49
50			/**
51			* @var JsonEncoder
52			*/
53			private $jsonEncoder;
54
55			/**
56			* @var JsonDecoder
57			*/
58			private $jsonDecoder;
59
60			/**
61			* @var FactoryManager
62			*/
63			private $factoryManager;
64
65			/**
66			* Creates a new storage.
67			*
68			* @param Storage $storage The file storage.
69			* @param JsonConverterProvider $converterProvider The provider for the JSON
70			* converters.
71			* @param JsonEncoder $jsonEncoder The JSON encoder.
72			* @param JsonDecoder $jsonDecoder The JSON decoder.
73			* @param FactoryManager\|null $factoryManager The manager used to
74			* regenerate the factory
75			* class after saving a file.
76			*/
77	68		public function __construct(
78			Storage $storage,
79			JsonConverterProvider $converterProvider,
80			JsonEncoder $jsonEncoder,
81			JsonDecoder $jsonDecoder,
82			FactoryManager $factoryManager = null
83			) {
84	68		$this->storage = $storage;
85	68		$this->converterProvider = $converterProvider;
86	68		$this->jsonEncoder = $jsonEncoder;
87	68		$this->jsonDecoder = $jsonDecoder;
88	68		$this->factoryManager = $factoryManager;
89	68		}
90
91			/**
92			* Loads a configuration file from a path.
93			*
94			* @param string $path The path to the configuration file.
95			* @param Config\|null $baseConfig The configuration that the loaded
96			* configuration will inherit its values
97			* from.
98			*
99			* @return ConfigFile The loaded configuration file.
100			*
101			* @throws FileNotFoundException If the file does not exist.
102			* @throws ReadException If the file cannot be read.
103			* @throws InvalidConfigException If the file contains invalid configuration.
104			*/
105	50		public function loadConfigFile($path, Config $baseConfig = null)
106			{
107	50		return $this->loadFile($path, 'Puli\Manager\Api\Config\ConfigFile', array(
108	50		'baseConfig' => $baseConfig,
109			));
110			}
111
112			/**
113			* Saves a configuration file.
114			*
115			* The configuration file is saved to the same path that it was read from.
116			*
117			* @param ConfigFile $configFile The configuration file to save.
118			*
119			* @throws WriteException If the file cannot be written.
120			* @throws InvalidConfigException If the file contains invalid configuration.
121			*/
122	4		public function saveConfigFile(ConfigFile $configFile)
123			{
124	4		$this->saveFile($configFile, $configFile->getPath());
125
126	2		if ($this->factoryManager) {
127	1		$this->factoryManager->autoGenerateFactoryClass();
128			}
129	2		}
130
131			/**
132			* Loads a module file from a file path.
133			*
134			* @param string $path The path to the module file.
135			*
136			* @return ModuleFile The loaded module file.
137			*
138			* @throws FileNotFoundException If the file does not exist.
139			* @throws ReadException If the file cannot be read.
140			* @throws InvalidConfigException If the file contains invalid configuration.
141			*/
142	17		public function loadModuleFile($path)
143			{
144	17		return $this->loadFile($path, 'Puli\Manager\Api\Module\ModuleFile');
145			}
146
147			/**
148			* Saves a module file.
149			*
150			* The module file is saved to the same path that it was read from.
151			*
152			* @param ModuleFile $moduleFile The module file to save.
153			*
154			* @throws WriteException If the file cannot be written.
155			* @throws InvalidConfigException If the file contains invalid configuration.
156			*/
157	3		public function saveModuleFile(ModuleFile $moduleFile)
158			{
159	3		$this->saveFile($moduleFile, $moduleFile->getPath(), array(
160	3		'targetVersion' => $moduleFile->getVersion(),
161			));
162	1		}
163
164			/**
165			* Loads a root module file from a file path.
166			*
167			* @param string $path The path to the module configuration file.
168			* @param Config $baseConfig The configuration that the module will inherit
169			* its configuration values from.
170			*
171			* @return RootModuleFile The loaded module file.
172			*
173			* @throws FileNotFoundException If the file does not exist.
174			* @throws ReadException If the file cannot be read.
175			* @throws InvalidConfigException If the file contains invalid configuration.
176			*/
177	30		public function loadRootModuleFile($path, Config $baseConfig)
178			{
179	30		return $this->loadFile($path, 'Puli\Manager\Api\Module\RootModuleFile', array(
180	30		'baseConfig' => $baseConfig,
181			));
182			}
183
184			/**
185			* Saves a root module file.
186			*
187			* The module file is saved to the same path that it was read from.
188			*
189			* @param RootModuleFile $moduleFile The module file to save.
190			*
191			* @throws WriteException If the file cannot be written.
192			* @throws InvalidConfigException If the file contains invalid configuration.
193			*/
194	4		public function saveRootModuleFile(RootModuleFile $moduleFile)
195			{
196	4		$this->saveFile($moduleFile, $moduleFile->getPath(), array(
197	4		'targetVersion' => $moduleFile->getVersion(),
198			));
199
200	2		if ($this->factoryManager) {
201	1		$this->factoryManager->autoGenerateFactoryClass();
202			}
203	2		}
204
205	57	View Code Duplication	private function loadFile($path, $className, array $options = array())
			0 ignored issues – show Duplication introduced 2016-02-01 14:50 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...
206			{
207	57		$json = $this->storage->read($path);
208	56		$jsonData = $this->decode($json, $path);
209	53		$options['path'] = $path;
210
211			try {
212	53		return $this->converterProvider->getJsonConverter($className)->fromJson($jsonData, $options);
213	3		} catch (ConversionFailedException $e) {
214	3		throw new InvalidConfigException(sprintf(
215	3		'The JSON in %s could not be converted: %s',
216			$path,
217	3		$e->getMessage()
218	3		), 0, $e);
219			}
220			}
221
222	11	View Code Duplication	private function saveFile($file, $path, array $options = array())
			0 ignored issues – show Duplication introduced 2016-02-01 14:50 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...
223			{
224	11		$className = get_class($file);
225
226			try {
227	11		$jsonData = $this->converterProvider->getJsonConverter($className)->toJson($file, $options);
228	3		} catch (ConversionFailedException $e) {
229	3		throw new InvalidConfigException(sprintf(
230	3		'The data written to %s could not be converted: %s',
231			$path,
232	3		$e->getMessage()
233	3		), 0, $e);
234			}
235
236	8		$json = $this->encode($jsonData, $path);
237
238	5		$this->storage->write($path, $json);
239	5		}
240
241	8		private function encode(stdClass $jsonData, $path)
242			{
243			try {
244	8		return $this->jsonEncoder->encode($jsonData);
245	3		} catch (EncodingFailedException $e) {
246	3		throw new InvalidConfigException(sprintf(
247	3		'The configuration in %s could not be encoded: %s',
248			$path,
249	3		$e->getMessage()
250	3		), 0, $e);
251			}
252			}
253
254	56		private function decode($json, $path)
255			{
256			try {
257	56		return $this->jsonDecoder->decode($json);
258	3		} catch (DecodingFailedException $e) {
259	3		throw new InvalidConfigException(sprintf(
260	3		'The configuration in %s could not be decoded: %s',
261			$path,
262	3		$e->getMessage()
263	3		), 0, $e);
264			}
265			}
266			}
267

puli / manager

Push — master ( 6343d0...45320b )

JsonStorage::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like