AbstractParameterHandler::handlePart() - Code Metrics - Inspection of "Retrofit 3" - tebru/retrofit-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#72)

by Nate

created 2017-09-12 22:31 UTC

AbstractParameterHandler::handlePart() B

↳ Parent: AbstractParameterHandler

Complexity

Conditions	4
Paths	4

Size

Total Lines	24
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.6845
c	0
b	0
f	0
cc	4
eloc	16
nc	4
nop	5

<?php
/*
 * Copyright (c) Nate Brunette.
 * Distributed under the MIT License (http://opensource.org/licenses/MIT)
 */

declare(strict_types=1);

namespace Tebru\Retrofit\Internal\ParameterHandler;

use Generator;
use RuntimeException;
use Tebru\Retrofit\Http\MultipartBody;
use Tebru\Retrofit\ParameterHandler;
use Tebru\Retrofit\Internal\RequestBuilder;
use Tebru\Retrofit\RequestBodyConverter;

/**
 * Class AbstractFieldHandler
 *
 * @author Nate Brunette <[email protected]>
 */
abstract class AbstractParameterHandler implements ParameterHandler
{
    private const HEADER_CON_TRANS_ENC = 'Content-Transfer-Encoding';

    /**
     * Convert a value to a generator
     *
     * This method is used when a value can optionally be an array and each element in the
     * array should be processed the same way.
     *
     * @param array|mixed $list
     * @return Generator
     * @throws \RuntimeException
     */
    protected function getListValues($list): Generator
    {
        foreach ((array)$list as $key => $element) {
            if (!is_int($key)) {
                throw new RuntimeException('Retrofit: Array value must use numeric keys');
            }

            yield $element;
        }
    }

    /**
     * Handle Part or PartMap annotations
     *
     * This could use a simple method using name and value, or if a [@see MultipartBody] is passed in as the
     * value, then a filename and additional headers could be set as well.
     *
     * @param RequestBuilder $requestBuilder
     * @param RequestBodyConverter $converter
     * @param string $name
     * @param mixed $value
     * @param string $encoding
     * @return void
     */
    protected function handlePart(
        RequestBuilder $requestBuilder,
        RequestBodyConverter $converter,
        string $name,
        $value,
        string $encoding
    ): void {
        if ($value === null) {
            return;
        }

        // if not a MultipartBody, only set name, contents, and content header
        if (!$value instanceof MultipartBody) {
            $requestBuilder->addPart($name, $converter->convert($value), [self::HEADER_CON_TRANS_ENC => $encoding]);
            return;
        }

        $headers = $value->getHeaders();
        if (!isset($headers[self::HEADER_CON_TRANS_ENC])) {
            $headers[self::HEADER_CON_TRANS_ENC] = $encoding;
        }

        $requestBuilder->addPart($value->getName(), $value->getContents(), $headers, $value->getFilename());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }
}


1			<?php
2			/*
3			* Copyright (c) Nate Brunette.
4			* Distributed under the MIT License (http://opensource.org/licenses/MIT)
5			*/
6
7			declare(strict_types=1);
8
9			namespace Tebru\Retrofit\Internal\ParameterHandler;
10
11			use Generator;
12			use RuntimeException;
13			use Tebru\Retrofit\Http\MultipartBody;
14			use Tebru\Retrofit\ParameterHandler;
15			use Tebru\Retrofit\Internal\RequestBuilder;
16			use Tebru\Retrofit\RequestBodyConverter;
17
18			/**
19			* Class AbstractFieldHandler
20			*
21			* @author Nate Brunette <[email protected]>
22			*/
23			abstract class AbstractParameterHandler implements ParameterHandler
24			{
25			private const HEADER_CON_TRANS_ENC = 'Content-Transfer-Encoding';
26
27			/**
28			* Convert a value to a generator
29			*
30			* This method is used when a value can optionally be an array and each element in the
31			* array should be processed the same way.
32			*
33			* @param array\|mixed $list
34			* @return Generator
35			* @throws \RuntimeException
36			*/
37			protected function getListValues($list): Generator
38			{
39			foreach ((array)$list as $key => $element) {
40			if (!is_int($key)) {
41			throw new RuntimeException('Retrofit: Array value must use numeric keys');
42			}
43
44			yield $element;
45			}
46			}
47
48			/**
49			* Handle Part or PartMap annotations
50			*
51			* This could use a simple method using name and value, or if a [@see MultipartBody] is passed in as the
52			* value, then a filename and additional headers could be set as well.
53			*
54			* @param RequestBuilder $requestBuilder
55			* @param RequestBodyConverter $converter
56			* @param string $name
57			* @param mixed $value
58			* @param string $encoding
59			* @return void
60			*/
61			protected function handlePart(
62			RequestBuilder $requestBuilder,
63			RequestBodyConverter $converter,
64			string $name,
65			$value,
66			string $encoding
67			): void {
68			if ($value === null) {
69			return;
70			}
71
72			// if not a MultipartBody, only set name, contents, and content header
73			if (!$value instanceof MultipartBody) {
74			$requestBuilder->addPart($name, $converter->convert($value), [self::HEADER_CON_TRANS_ENC => $encoding]);
75			return;
76			}
77
78			$headers = $value->getHeaders();
79			if (!isset($headers[self::HEADER_CON_TRANS_ENC])) {
80			$headers[self::HEADER_CON_TRANS_ENC] = $encoding;
81			}
82
83			$requestBuilder->addPart($value->getName(), $value->getContents(), $headers, $value->getFilename());
			0 ignored issues – show Bug introduced 2017-09-12 22:35 UTC by Report Bug Copy Issue Report It seems like `$value->getContents()` can be `null`; however, `addPart()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
84			}
85			}
86

tebru / retrofit-php

Pull Request — master (#72)

AbstractParameterHandler::handlePart() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like