YamlDecode::contextToOptions() - Code Metrics - Inspection of "Support wider range of PHP versions" - fitbug/symfony-yaml-serializer-encoder-decoder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1)

by Billie

created 2016-08-12 13:43 UTC

YamlDecode::contextToOptions() B

↳ Parent: YamlDecode

Complexity

Conditions	4
Paths	6

Size

Total Lines	24
Code Lines	12

Duplication

Lines	24
Ratio	100 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	24
loc	24
rs	8.6845
cc	4
eloc	12
nc	6
nop	1

<?php

namespace Fitbug\SymfonySerializer\YamlEncoderDecoder;

use Symfony\Component\Serializer\Encoder\DecoderInterface;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Yaml\Yaml;

class YamlDecode implements DecoderInterface
{
    const OPTION_EXCEPTION_ON_INVALID_TYPE = 'yaml_decode_exception_on_invalid_type';
    const OPTION_OBJECT                    = 'yaml_decode_object';
    const OPTION_OBJECT_FOR_MAP            = 'yaml_decode_object_for_map';
    const OPTION_DATE_TIME                 = 'yaml_decode_date_time';
    const SUPPORTED_ENCODING_YAML          = "yaml";
    /**
     * @var bool
     */
    private $exceptionOnInvalidType;
    /**
     * @var bool
     */
    private $object;
    /**
     * @var bool
     */
    private $objectForMap;
    /**
     * @var bool
     */
    private $dateTime;

    /**
     * Constructs a new YamlDecode instance.
     *
     * @param bool $exceptionOnInvalidType
     * @param bool $object
     * @param bool $objectForMap
     * @param bool $dateTime
     */
    public function __construct(
        $exceptionOnInvalidType = false,

        $object = false,
        $objectForMap = false,
        $dateTime = false
    ) {
        $this->exceptionOnInvalidType = $exceptionOnInvalidType;
        $this->object                 = $object;
        $this->objectForMap           = $objectForMap;
        $this->dateTime               = $dateTime;
    }

    /**
     * Decodes a string into PHP data.
     *
     * @param string $data    Data to decode
     * @param string $format  Format name
     * @param array  $context options that decoders have access to
     *
     * The format parameter specifies which format the data is in; valid values
     * depend on the specific implementation. The only format we support is 'yaml'
     *
     * @return mixed

     *
     * @throws UnexpectedValueException
     */
    public function decode($data, $format, array $context = [])
    {
        $context = $this->resolveContext($context);
        $options = $this->contextToOptions($context);

        return Yaml::parse($data, $options);
    }

    /**
     * Checks whether the deserializer can decode from given format.
     *
     * We only support yaml.
     *
     * @param string $format format name
     *
     * @return bool
     */
    public function supportsDecoding($format)
    {
        return $format == self::SUPPORTED_ENCODING_YAML;
    }

    /**
     * Merges the default options of the Yaml Decoder with the passed context.
     *
     * @param array $context
     *
     * @return array
     */
    private function resolveContext(array $context)
    {
        $defaultOptions = [
            self::OPTION_EXCEPTION_ON_INVALID_TYPE => $this->exceptionOnInvalidType,
            self::OPTION_OBJECT                    => $this->object,
            self::OPTION_OBJECT_FOR_MAP            => $this->objectForMap,
            self::OPTION_DATE_TIME                 => $this->dateTime,
        ];

        return array_merge($defaultOptions, $context);
    }

    /**
     * Convert the context to options understood by the parser
     *
     * @param array $options
     *
     * @return int
     */
    private function contextToOptions(array $options)

    {
        $optionToBitMap = [
            self::OPTION_OBJECT                    => Yaml::PARSE_OBJECT,
            self::OPTION_OBJECT_FOR_MAP            => Yaml::PARSE_OBJECT_FOR_MAP,
            self::OPTION_DATE_TIME                 => Yaml::PARSE_DATETIME,
        ];

        // For PHP 5.4 compatability
        if (defined("Symfony\\Component\\Yaml\\Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE")) {
            $optionToBitMap[ self::OPTION_EXCEPTION_ON_INVALID_TYPE ] = Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE;
        }

        
        $bitMaskedOption = 0;

        foreach ($optionToBitMap as $option => $bitMask) {
            if ($options[ $option ]) {
                $bitMaskedOption = $bitMaskedOption | $bitMask;
            }
        }

        return $bitMaskedOption;
    }
}


1		<?php
2
3		namespace Fitbug\SymfonySerializer\YamlEncoderDecoder;
4
5		use Symfony\Component\Serializer\Encoder\DecoderInterface;
6		use Symfony\Component\Serializer\Exception\UnexpectedValueException;
7		use Symfony\Component\Yaml\Yaml;
8
9		class YamlDecode implements DecoderInterface
10		{
11		const OPTION_EXCEPTION_ON_INVALID_TYPE = 'yaml_decode_exception_on_invalid_type';
12		const OPTION_OBJECT = 'yaml_decode_object';
13		const OPTION_OBJECT_FOR_MAP = 'yaml_decode_object_for_map';
14		const OPTION_DATE_TIME = 'yaml_decode_date_time';
15		const SUPPORTED_ENCODING_YAML = "yaml";
16		/**
17		* @var bool
18		*/
19		private $exceptionOnInvalidType;
20		/**
21		* @var bool
22		*/
23		private $object;
24		/**
25		* @var bool
26		*/
27		private $objectForMap;
28		/**
29		* @var bool
30		*/
31		private $dateTime;
32
33		/**
34		* Constructs a new YamlDecode instance.
35		*
36		* @param bool $exceptionOnInvalidType
37		* @param bool $object
38		* @param bool $objectForMap
39		* @param bool $dateTime
40		*/
41		public function __construct(
42		$exceptionOnInvalidType = false,
		0 ignored issues – show Comprehensibility Naming introduced 2016-08-12 11:27 UTC by Report Bug Copy Issue Report The variable name `$exceptionOnInvalidType` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
43		$object = false,
44		$objectForMap = false,
45		$dateTime = false
46		) {
47		$this->exceptionOnInvalidType = $exceptionOnInvalidType;
48		$this->object = $object;
49		$this->objectForMap = $objectForMap;
50		$this->dateTime = $dateTime;
51		}
52
53		/**
54		* Decodes a string into PHP data.
55		*
56		* @param string $data Data to decode
57		* @param string $format Format name
58		* @param array $context options that decoders have access to
59		*
60		* The format parameter specifies which format the data is in; valid values
61		* depend on the specific implementation. The only format we support is 'yaml'
62		*
63		* @return mixed
		0 ignored issues – show Documentation introduced 2016-08-12 11:27 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `array\|string\|\stdClass`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
64		*
65		* @throws UnexpectedValueException
66		*/
67		public function decode($data, $format, array $context = [])
68		{
69		$context = $this->resolveContext($context);
70		$options = $this->contextToOptions($context);
71
72		return Yaml::parse($data, $options);
73		}
74
75		/**
76		* Checks whether the deserializer can decode from given format.
77		*
78		* We only support yaml.
79		*
80		* @param string $format format name
81		*
82		* @return bool
83		*/
84		public function supportsDecoding($format)
85		{
86		return $format == self::SUPPORTED_ENCODING_YAML;
87		}
88
89		/**
90		* Merges the default options of the Yaml Decoder with the passed context.
91		*
92		* @param array $context
93		*
94		* @return array
95		*/
96		private function resolveContext(array $context)
97		{
98		$defaultOptions = [
99		self::OPTION_EXCEPTION_ON_INVALID_TYPE => $this->exceptionOnInvalidType,
100		self::OPTION_OBJECT => $this->object,
101		self::OPTION_OBJECT_FOR_MAP => $this->objectForMap,
102		self::OPTION_DATE_TIME => $this->dateTime,
103		];
104
105		return array_merge($defaultOptions, $context);
106		}
107
108		/**
109		* Convert the context to options understood by the parser
110		*
111		* @param array $options
112		*
113		* @return int
114		*/
115	View Code Duplication	private function contextToOptions(array $options)
		0 ignored issues – show Duplication introduced 2016-08-12 11:27 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...
116		{
117		$optionToBitMap = [
118		self::OPTION_OBJECT => Yaml::PARSE_OBJECT,
119		self::OPTION_OBJECT_FOR_MAP => Yaml::PARSE_OBJECT_FOR_MAP,
120		self::OPTION_DATE_TIME => Yaml::PARSE_DATETIME,
121		];
122
123		// For PHP 5.4 compatability
124		if (defined("Symfony\\Component\\Yaml\\Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE")) {
125		$optionToBitMap[ self::OPTION_EXCEPTION_ON_INVALID_TYPE ] = Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE;
126		}
127
128
129		$bitMaskedOption = 0;
130
131		foreach ($optionToBitMap as $option => $bitMask) {
132		if ($options[ $option ]) {
133		$bitMaskedOption = $bitMaskedOption \| $bitMask;
134		}
135		}
136
137		return $bitMaskedOption;
138		}
139		}
140

fitbug / symfony-yaml-serializer-encoder-decoder

Pull Request — master (#1)

YamlDecode::contextToOptions() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like