YamlEncode::encode() - Code Metrics - Inspection of "Merge pull request #1 from fitbug/support-wider-ra..." - fitbug/symfony-yaml-serializer-encoder-decoder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 57ea59...de3279 )

by Billie

created 2016-08-12 14:15 UTC

YamlEncode::encode() B

↳ Parent: YamlEncode

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	26
rs	8.8571
cc	2
eloc	17
nc	2
nop	3

<?php

namespace Fitbug\SymfonySerializer\YamlEncoderDecoder;

use Symfony\Component\Serializer\Encoder\EncoderInterface;
use Symfony\Component\Serializer\Encoder\scalar;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Yaml\Yaml;

class YamlEncode implements EncoderInterface
{
    const OPTION_OBJECT                    = 'yaml_encode_object';
    const OPTION_EXCEPTION_ON_INVALID_TYPE = 'yaml_encode_exception_on_invalid_type';
    const OPTION_OBJECT_FOR_MAP            = 'yaml_encode_object_for_map';
    const OPTION_MULTI_LINE_LITERAL_BLOCK  = 'yaml_encode_multi_line_literal_block';
    const OPTION_INLINE                    = 'yaml_encode_inline';
    const OPTION_INDENT                    = 'yaml_encode_indent';
    const SUPPORTED_ENCODING_YAML          = 'yaml';

    /**
     * @var bool
     */
    private $multiLineLiteralBlock;

    /**
     * @var bool
     */
    private $exceptionOnInvalidType;

    /**
     * @var bool
     */
    private $objectForMap;

    /**
     * @var bool
     */
    private $object;
    /**
     * @var int
     */
    private $indent;
    /**
     * @var int
     */
    private $inline;

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

        $objectForMap = false,
        $multiLineLiteralBlock = false,

        $inline = 2,
        $indent = 2
    ) {
        $this->object                 = $object;
        $this->exceptionOnInvalidType = $exceptionOnInvalidType;
        $this->objectForMap           = $objectForMap;
        $this->multiLineLiteralBlock  = $multiLineLiteralBlock;
        $this->indent                 = $indent;

        $this->inline = $inline;
    }

    /**
     * Encodes data into the given format.
     *
     * The only supported is yaml
     *
     * @param mixed  $data    Data to encode
     * @param string $format  Format name
     * @param array  $context options that normalizers/encoders have access to
     *
     * @return string
     *
     * @throws UnexpectedValueException
     */
    public function encode($data, $format, array $context = [])
    {
        $context = $this->resolveContext($context);

        if ($this->isYamlOldStyleInterface()) {
            $encodedData = Yaml::dump(
                $data,
                $context[ self::OPTION_INLINE ],
                $context[ self::OPTION_INDENT ],
                $context[ self::OPTION_EXCEPTION_ON_INVALID_TYPE ],
                $context[ self::OPTION_OBJECT ]
            );

        } else {
            $options = $this->contextToOptions($context);

            $encodedData = Yaml::dump(
                $data,
                $context[ self::OPTION_INLINE ],
                $context[ self::OPTION_INDENT ],
                $options
            );
        }

        return $encodedData;
    }

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

        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::DUMP_OBJECT,
            self::OPTION_EXCEPTION_ON_INVALID_TYPE => Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE,
            self::OPTION_OBJECT_FOR_MAP            => Yaml::DUMP_OBJECT_AS_MAP,
            self::OPTION_MULTI_LINE_LITERAL_BLOCK  => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,
        ];

        $bitMaskedOption = 0;

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

        return $bitMaskedOption;
    }


    /**
     * Checks whether the serializer can encode to given format.
     *
     * The only supported format is yaml
     *
     * @param string $format format name
     *
     * @return bool
     */
    public function supportsEncoding($format)
    {
        return $format == self::SUPPORTED_ENCODING_YAML;
    }

    private function isYamlOldStyleInterface()
    {
        return !defined("Symfony\\Component\\Yaml\\Yaml::DUMP_OBJECT");
    }
}


1		<?php
2
3		namespace Fitbug\SymfonySerializer\YamlEncoderDecoder;
4
5		use Symfony\Component\Serializer\Encoder\EncoderInterface;
6		use Symfony\Component\Serializer\Encoder\scalar;
7		use Symfony\Component\Serializer\Exception\UnexpectedValueException;
8		use Symfony\Component\Yaml\Yaml;
9
10		class YamlEncode implements EncoderInterface
11		{
12		const OPTION_OBJECT = 'yaml_encode_object';
13		const OPTION_EXCEPTION_ON_INVALID_TYPE = 'yaml_encode_exception_on_invalid_type';
14		const OPTION_OBJECT_FOR_MAP = 'yaml_encode_object_for_map';
15		const OPTION_MULTI_LINE_LITERAL_BLOCK = 'yaml_encode_multi_line_literal_block';
16		const OPTION_INLINE = 'yaml_encode_inline';
17		const OPTION_INDENT = 'yaml_encode_indent';
18		const SUPPORTED_ENCODING_YAML = 'yaml';
19
20		/**
21		* @var bool
22		*/
23		private $multiLineLiteralBlock;
24
25		/**
26		* @var bool
27		*/
28		private $exceptionOnInvalidType;
29
30		/**
31		* @var bool
32		*/
33		private $objectForMap;
34
35		/**
36		* @var bool
37		*/
38		private $object;
39		/**
40		* @var int
41		*/
42		private $indent;
43		/**
44		* @var int
45		*/
46		private $inline;
47
48		/**
49		* Constructs a new YamlDecode instance.
50		*
51		* @param bool $object
52		* @param bool $exceptionOnInvalidType
53		* @param bool $objectForMap
54		* @param bool $multiLineLiteralBlock
55		* @param int $inline
56		* @param int $indent
57		*/
58		public function __construct(
59		$object = false,
60		$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...
61		$objectForMap = false,
62		$multiLineLiteralBlock = false,
		0 ignored issues – show Comprehensibility Naming introduced 2016-08-12 11:27 UTC by Report Bug Copy Issue Report The variable name `$multiLineLiteralBlock` 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...
63		$inline = 2,
64		$indent = 2
65		) {
66		$this->object = $object;
67		$this->exceptionOnInvalidType = $exceptionOnInvalidType;
68		$this->objectForMap = $objectForMap;
69		$this->multiLineLiteralBlock = $multiLineLiteralBlock;
70		$this->indent = $indent;
71
72		$this->inline = $inline;
73		}
74
75		/**
76		* Encodes data into the given format.
77		*
78		* The only supported is yaml
79		*
80		* @param mixed $data Data to encode
81		* @param string $format Format name
82		* @param array $context options that normalizers/encoders have access to
83		*
84		* @return string
85		*
86		* @throws UnexpectedValueException
87		*/
88		public function encode($data, $format, array $context = [])
89		{
90		$context = $this->resolveContext($context);
91
92		if ($this->isYamlOldStyleInterface()) {
93		$encodedData = Yaml::dump(
94		$data,
95		$context[ self::OPTION_INLINE ],
96		$context[ self::OPTION_INDENT ],
97		$context[ self::OPTION_EXCEPTION_ON_INVALID_TYPE ],
98		$context[ self::OPTION_OBJECT ]
99		);
100
101		} else {
102		$options = $this->contextToOptions($context);
103
104		$encodedData = Yaml::dump(
105		$data,
106		$context[ self::OPTION_INLINE ],
107		$context[ self::OPTION_INDENT ],
108		$options
109		);
110		}
111
112		return $encodedData;
113		}
114
115		/**
116		* Merges the default options of the Yaml Encoder with the passed context.
117		*
118		* @param array $context
119		*
120		* @return array
121		*/
122		private function resolveContext(array $context)
123		{
124		$defaultOptions = [
125		self::OPTION_OBJECT => $this->object,
126		self::OPTION_EXCEPTION_ON_INVALID_TYPE => $this->exceptionOnInvalidType,
127		self::OPTION_OBJECT_FOR_MAP => $this->objectForMap,
128		self::OPTION_MULTI_LINE_LITERAL_BLOCK => $this->multiLineLiteralBlock,
129		self::OPTION_INLINE => $this->inline,
130		self::OPTION_INDENT => $this->indent,
131		];
132
133		return array_merge($defaultOptions, $context);
134		}
135
136		/**
137		* Convert the context to options understood by the parser
138		*
139		* @param array $options
140		*
141		* @return int
142		*/
143	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...
144		{
145		$optionToBitMap = [
146		self::OPTION_OBJECT => Yaml::DUMP_OBJECT,
147		self::OPTION_EXCEPTION_ON_INVALID_TYPE => Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE,
148		self::OPTION_OBJECT_FOR_MAP => Yaml::DUMP_OBJECT_AS_MAP,
149		self::OPTION_MULTI_LINE_LITERAL_BLOCK => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,
150		];
151
152		$bitMaskedOption = 0;
153
154		foreach ($optionToBitMap as $option => $bitMask) {
155		if ($options[ $option ]) {
156		$bitMaskedOption = $bitMaskedOption \| $bitMask;
157		}
158		}
159
160		return $bitMaskedOption;
161		}
162
163
164		/**
165		* Checks whether the serializer can encode to given format.
166		*
167		* The only supported format is yaml
168		*
169		* @param string $format format name
170		*
171		* @return bool
172		*/
173		public function supportsEncoding($format)
174		{
175		return $format == self::SUPPORTED_ENCODING_YAML;
176		}
177
178		private function isYamlOldStyleInterface()
179		{
180		return !defined("Symfony\\Component\\Yaml\\Yaml::DUMP_OBJECT");
181		}
182		}
183

fitbug / symfony-yaml-serializer-encoder-decoder

Push — master ( 57ea59...de3279 )

YamlEncode::encode() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like