ApiResponseDataFactory::createFromResponse() - Code Metrics - Inspection of "Use `composer serve` for tests." - yiisoft/app-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#188)

by Wilmer

created 2024-02-11 11:34 UTC

ApiResponseDataFactory::createFromResponse() A

↳ Parent: ApiResponseDataFactory

Complexity

Conditions	4
Paths	3

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0092

Importance

Changes

Metric	Value
cc	4
eloc	11
nc	3
nop	1
dl	0
loc	18
ccs	11
cts	12
cp	0.9167
crap	4.0092
rs	9.9
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace App\Http;

use RuntimeException;
use Yiisoft\DataResponse\DataResponse;
use Yiisoft\Http\Status;

final class ApiResponseDataFactory
{
    public function createFromResponse(DataResponse $response): ApiResponseData
    {
        if ($response->getStatusCode() !== Status::OK) {
            return $this
                ->createErrorResponse()
                ->setErrorCode($response->getStatusCode())
                ->setErrorMessage($this->getErrorMessage($response));
        }

        $data = $response->getData();

        if ($data !== null && !is_array($data)) {
            throw new RuntimeException('The response data must be either null or an array');
        }

        return $this
            ->createSuccessResponse()
            ->setData($data);
    }

    public function createSuccessResponse(): ApiResponseData
    {
        return $this
            ->createResponse()
            ->setStatus('success');
    }

    public function createErrorResponse(): ApiResponseData
    {
        return $this
            ->createResponse()
            ->setStatus('failed');
    }

    public function createResponse(): ApiResponseData
    {
        return new ApiResponseData();
    }

    private function getErrorMessage(DataResponse $response): string
    {
        $data = $response->getData();
        if (is_string($data) && !empty($data)) {
            return $data;
        }

        return 'Unknown error';
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace App\Http;
6
7		use RuntimeException;
8		use Yiisoft\DataResponse\DataResponse;
9		use Yiisoft\Http\Status;
10
11		final class ApiResponseDataFactory
12		{
13	2	public function createFromResponse(DataResponse $response): ApiResponseData
14		{
15	2	if ($response->getStatusCode() !== Status::OK) {
16	1	return $this
17	1	->createErrorResponse()
18	1	->setErrorCode($response->getStatusCode())
19	1	->setErrorMessage($this->getErrorMessage($response));
20		}
21
22	1	$data = $response->getData();
23
24	1	if ($data !== null && !is_array($data)) {
25		throw new RuntimeException('The response data must be either null or an array');
26		}
27
28	1	return $this
29	1	->createSuccessResponse()
30	1	->setData($data);
31		}
32
33	1	public function createSuccessResponse(): ApiResponseData
34		{
35	1	return $this
36	1	->createResponse()
37	1	->setStatus('success');
38		}
39
40	1	public function createErrorResponse(): ApiResponseData
41		{
42	1	return $this
43	1	->createResponse()
44	1	->setStatus('failed');
45		}
46
47	2	public function createResponse(): ApiResponseData
48		{
49	2	return new ApiResponseData();
50		}
51
52	1	private function getErrorMessage(DataResponse $response): string
53		{
54	1	$data = $response->getData();
55	1	if (is_string($data) && !empty($data)) {
56	1	return $data;
57		}
58
59		return 'Unknown error';
60		}
61		}
62

yiisoft / app-api

Pull Request — master (#188)

ApiResponseDataFactory::createFromResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like