CacheFileStorage::encode() - Code Metrics - Inspection of "[WIP] Cache combined puli.json files of all instal..." - puli/manager - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#47)

by Mateusz

created 2016-02-08 19:04 UTC

CacheFileStorage::encode() A

↳ Parent: CacheFileStorage

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	9

Duplication

Lines	12
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	12
loc	12
ccs	0
cts	7
cp	0
rs	9.4285
cc	2
eloc	9
nc	2
nop	2
crap	6

<?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\Cache;

use Puli\Manager\Api\Cache\CacheFile;
use Puli\Manager\Api\FileNotFoundException;
use Puli\Manager\Api\InvalidConfigException;
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\Conversion\JsonConverter;
use Webmozart\Json\DecodingFailedException;
use Webmozart\Json\EncodingFailedException;
use Webmozart\Json\JsonDecoder;
use Webmozart\Json\JsonEncoder;

/**
 * Loads and saves cache files.
 *
 * @since  1.0
 *
 * @author Mateusz Sojda <[email protected]>
 */
class CacheFileStorage
{
    /**
     * @var Storage
     */
    private $storage;

    /**
     * @var JsonConverter
     */
    private $converter;

    /**
     * Creates a new storage.
     *
     * @param Storage         $storage          The file storage.
     * @param JsonConverter   $converter        The cache file converter.
     * @param JsonEncoder     $jsonEncoder      The JSON encoder.
     * @param JsonDecoder     $jsonDecoder      The JSON decoder.
     */
    public function __construct(
        Storage $storage,
        JsonConverter $converter,
        JsonEncoder $jsonEncoder,
        JsonDecoder $jsonDecoder
    )
    {
        $this->storage = $storage;
        $this->converter = $converter;
        $this->jsonEncoder = $jsonEncoder;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->jsonDecoder = $jsonDecoder;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Loads a cache file from a file path.
     *
     * @param string $path The path to the cache file.
     *
     * @return CacheFile The loaded cache 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 loadCacheFile($path)
    {
        $serialized = $this->storage->read($path);
        $jsonData = $this->decode($serialized, $path);

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

    /**
     * Saves a cache file.
     *
     * The cache file is saved to the same path that it was read from.
     *
     * @param CacheFile $cacheFile The cache file to save.
     *
     * @throws WriteException If the file cannot be written.
     */
    public function saveCacheFile(CacheFile $cacheFile)
    {
        $jsonData = $this->converter->toJson($cacheFile);
        $serialized = $this->encode($jsonData, $cacheFile->getPath());

        $this->storage->write($cacheFile->getPath(), $serialized);
    }

    /**
     * Returns whether a cache file exists.
     *
     * @param string $path The cache file path.
     *
     * @return bool Returns `true` if the cache file exists and `false` otherwise.
     */
    public function fileExists($path)
    {
        return $this->storage->exists($path);
    }

    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\Cache;
13
14			use Puli\Manager\Api\Cache\CacheFile;
15			use Puli\Manager\Api\FileNotFoundException;
16			use Puli\Manager\Api\InvalidConfigException;
17			use Puli\Manager\Api\Storage\ReadException;
18			use Puli\Manager\Api\Storage\Storage;
19			use Puli\Manager\Api\Storage\WriteException;
20			use stdClass;
21			use Webmozart\Json\Conversion\ConversionFailedException;
22			use Webmozart\Json\Conversion\JsonConverter;
23			use Webmozart\Json\DecodingFailedException;
24			use Webmozart\Json\EncodingFailedException;
25			use Webmozart\Json\JsonDecoder;
26			use Webmozart\Json\JsonEncoder;
27
28			/**
29			* Loads and saves cache files.
30			*
31			* @since 1.0
32			*
33			* @author Mateusz Sojda <[email protected]>
34			*/
35			class CacheFileStorage
36			{
37			/**
38			* @var Storage
39			*/
40			private $storage;
41
42			/**
43			* @var JsonConverter
44			*/
45			private $converter;
46
47			/**
48			* Creates a new storage.
49			*
50			* @param Storage $storage The file storage.
51			* @param JsonConverter $converter The cache file converter.
52			* @param JsonEncoder $jsonEncoder The JSON encoder.
53			* @param JsonDecoder $jsonDecoder The JSON decoder.
54			*/
55	1		public function __construct(
56			Storage $storage,
57			JsonConverter $converter,
58			JsonEncoder $jsonEncoder,
59			JsonDecoder $jsonDecoder
60			)
61			{
62	1		$this->storage = $storage;
63	1		$this->converter = $converter;
64	1		$this->jsonEncoder = $jsonEncoder;
			0 ignored issues – show Bug introduced 2016-01-30 20:38 UTC by Report Bug Copy Issue Report The property `jsonEncoder` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
65	1		$this->jsonDecoder = $jsonDecoder;
			0 ignored issues – show Bug introduced 2016-01-30 20:38 UTC by Report Bug Copy Issue Report The property `jsonDecoder` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
66	1		}
67
68			/**
69			* Loads a cache file from a file path.
70			*
71			* @param string $path The path to the cache file.
72			*
73			* @return CacheFile The loaded cache file.
74			*
75			* @throws FileNotFoundException If the file does not exist.
76			* @throws ReadException If the file cannot be read.
77			* @throws InvalidConfigException If the file contains invalid
78			* configuration.
79			*/
80			public function loadCacheFile($path)
81			{
82			$serialized = $this->storage->read($path);
83			$jsonData = $this->decode($serialized, $path);
84
85			try {
86			return $this->converter->fromJson($jsonData, array(
87			'path' => $path
88			));
89			} catch (ConversionFailedException $e) {
90			throw new InvalidConfigException(sprintf(
91			'The JSON in %s could not be converted: %s',
92			$path,
93			$e->getMessage()
94			), 0, $e);
95			}
96			}
97
98			/**
99			* Saves a cache file.
100			*
101			* The cache file is saved to the same path that it was read from.
102			*
103			* @param CacheFile $cacheFile The cache file to save.
104			*
105			* @throws WriteException If the file cannot be written.
106			*/
107			public function saveCacheFile(CacheFile $cacheFile)
108			{
109			$jsonData = $this->converter->toJson($cacheFile);
110			$serialized = $this->encode($jsonData, $cacheFile->getPath());
111
112			$this->storage->write($cacheFile->getPath(), $serialized);
113			}
114
115			/**
116			* Returns whether a cache file exists.
117			*
118			* @param string $path The cache file path.
119			*
120			* @return bool Returns `true` if the cache file exists and `false` otherwise.
121			*/
122			public function fileExists($path)
123			{
124			return $this->storage->exists($path);
125			}
126
127		View Code Duplication	private function encode(stdClass $jsonData, $path)
			0 ignored issues – show Documentation introduced 2016-01-30 20:38 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Duplication introduced 2016-01-30 20:38 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...
128			{
129			try {
130			return $this->jsonEncoder->encode($jsonData);
131			} catch (EncodingFailedException $e) {
132			throw new InvalidConfigException(sprintf(
133			'The configuration in %s could not be encoded: %s',
134			$path,
135			$e->getMessage()
136			), 0, $e);
137			}
138			}
139
140		View Code Duplication	private function decode($json, $path)
			0 ignored issues – show Documentation introduced 2016-01-30 20:38 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history... Duplication introduced 2016-01-30 20:38 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...
141			{
142			try {
143			return $this->jsonDecoder->decode($json);
144			} catch (DecodingFailedException $e) {
145			throw new InvalidConfigException(sprintf(
146			'The configuration in %s could not be decoded: %s',
147			$path,
148			$e->getMessage()
149			), 0, $e);
150			}
151			}
152			}

puli / manager

Pull Request — master (#47)

CacheFileStorage::encode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like