IsResponse::jsonSerialize() - Code Metrics - Inspection of "Updates "homepage" in composer.json" - meare/juggler - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 816792...074308 )

by Andrejs

created 2017-01-13 15:21 UTC

IsResponse::jsonSerialize() A

↳ Parent: IsResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php

namespace Meare\Juggler\Imposter\Stub\Response;


class IsResponse implements IResponse
{
    const MODE_TEXT = 'text';
    const MODE_BINARY = 'binary';

    /**
     * @var string
     */
    private $type = self::TYPE_IS;

    /**
     * @var int
     */
    private $statusCode;

    /**
     * @var array
     */
    private $headers = [];

    /**
     * Starting from Juggler 1.4.3 inline JSON is allowed as http/s response bodies
     *
     * @var string|array
     */
    private $body;

    /**
     * @var string
     */
    private $mode = self::MODE_TEXT;

    /**
     * @param int          $status_code
     * @param array        $headers
     * @param string|array $body
     * @param string       $mode
     */
    public function __construct(int $status_code = 200, array $headers = [], $body = null, string $mode = null)
    {
        $this->setStatusCode($status_code);
        $this->setHeaders($headers);
        if (null !== $body) {
            $this->setBody($body);
        }
        if (null !== $mode) {
            $this->setMode($mode);
        }
    }

    /**
     * @param array $contract
     * @return self
     */
    public static function createFromContract($contract) : self
    {
        if (!isset($contract['statusCode'])) {
            throw new \InvalidArgumentException("Cannot create IsResponse from contract: Invalid contract; 'statusCode' field does not exists");
        }

        return new self(
            $contract['statusCode'],
            $contract['headers'] ?? [],
            $contract['body'] ?? null,
            $contract['_mode'] ?? null
        );
    }

    /**
     * @param callable $callback
     */
    public function modifyBody(callable $callback)
    {
        $body = $callback($this->getBody());
        if (null === $body) {
            throw new \LogicException('Expected new body as return value, got null');
        }
        $this->setBody($body);
    }

    /**
     * @return array|string mountebank 1.4.3: You can now use inline JSON for http/s response bodies rather than a
     *                      string.
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * @param array|string $body
     */
    public function setBody($body)
    {
        if (!is_string($body) && !is_array($body)) {
            throw new \InvalidArgumentException('Unable to set IsResponse body; Expected body to be string or array, '
                . 'got ' . gettype($body));
        }
        $this->body = $body;
    }

    /**
     * @return array
     */
    public function jsonSerialize() : array
    {
        return [
            IResponse::TYPE_IS => [
                'statusCode' => $this->getStatusCode(),
                'headers'    => $this->getHeaders(),
                'body'       => $this->getBody(),
                '_mode'      => $this->getMode(),
            ],
        ];
    }

    /**
     * @return int
     */
    public function getStatusCode() : int
    {
        return $this->statusCode;
    }

    /**
     * @param int $status_code
     */
    public function setStatusCode(int $status_code)
    {
        $this->statusCode = $status_code;
    }

    /**
     * @return array
     */
    public function getHeaders() : array
    {
        return $this->headers;
    }

    /**
     * TODO headers with same name
     *
     * @param array $headers ['name' => 'value', ..]
     */
    public function setHeaders(array $headers)
    {
        foreach ($headers as $name => $value) {
            $this->setHeader($name, $value);
        }
    }

    /**
     * @return string
     */
    public function getMode() : string
    {
        return $this->mode;
    }

    /**
     * @param string $mode
     */
    public function setMode(string $mode)

    {
        if (!in_array($mode, [self::MODE_TEXT, self::MODE_BINARY])) {
            throw new \InvalidArgumentException("Unable to set IsResponse mode; Invalid mode: '$mode'");
        }
        $this->mode = $mode;
    }

    /**
     * @return string
     */
    public function getType() : string
    {
        return $this->type;
    }

    /**
     * @param string $name
     * @param string $value
     */
    public function setHeader($name, $value)
    {
        if (!is_string($name)) {
            throw new \InvalidArgumentException(
                'Unable to set IsResponse headers; Header name expected be string, '
                . gettype($name) . " received ('" . (string)$name . "')"
            );
        }
        $this->headers[$name] = $value;
    }

    /**
     * @param string $name
     * @return mixed|null
     */
    public function getHeader($name)
    {
        return isset($this->headers[$name]) ? $this->headers[$name] : null;
    }
}


1			<?php
2
3			namespace Meare\Juggler\Imposter\Stub\Response;
4
5
6			class IsResponse implements IResponse
7			{
8			const MODE_TEXT = 'text';
9			const MODE_BINARY = 'binary';
10
11			/**
12			* @var string
13			*/
14			private $type = self::TYPE_IS;
15
16			/**
17			* @var int
18			*/
19			private $statusCode;
20
21			/**
22			* @var array
23			*/
24			private $headers = [];
25
26			/**
27			* Starting from Juggler 1.4.3 inline JSON is allowed as http/s response bodies
28			*
29			* @var string\|array
30			*/
31			private $body;
32
33			/**
34			* @var string
35			*/
36			private $mode = self::MODE_TEXT;
37
38			/**
39			* @param int $status_code
40			* @param array $headers
41			* @param string\|array $body
42			* @param string $mode
43			*/
44	28		public function __construct(int $status_code = 200, array $headers = [], $body = null, string $mode = null)
45			{
46	28		$this->setStatusCode($status_code);
47	28		$this->setHeaders($headers);
48	28		if (null !== $body) {
49	6		$this->setBody($body);
50			}
51	27		if (null !== $mode) {
52	2		$this->setMode($mode);
53			}
54	27		}
55
56			/**
57			* @param array $contract
58			* @return self
59			*/
60	3		public static function createFromContract($contract) : self
61			{
62	3		if (!isset($contract['statusCode'])) {
63	1		throw new \InvalidArgumentException("Cannot create IsResponse from contract: Invalid contract; 'statusCode' field does not exists");
64			}
65
66	2		return new self(
67	2		$contract['statusCode'],
68	2		$contract['headers'] ?? [],
69	2		$contract['body'] ?? null,
70	2		$contract['_mode'] ?? null
71			);
72			}
73
74			/**
75			* @param callable $callback
76			*/
77	2		public function modifyBody(callable $callback)
78			{
79	2		$body = $callback($this->getBody());
80	2		if (null === $body) {
81	1		throw new \LogicException('Expected new body as return value, got null');
82			}
83	1		$this->setBody($body);
84	1		}
85
86			/**
87			* @return array\|string mountebank 1.4.3: You can now use inline JSON for http/s response bodies rather than a
88			* string.
89			*/
90	8		public function getBody()
91			{
92	8		return $this->body;
93			}
94
95			/**
96			* @param array\|string $body
97			*/
98	6		public function setBody($body)
99			{
100	6		if (!is_string($body) && !is_array($body)) {
101	1		throw new \InvalidArgumentException('Unable to set IsResponse body; Expected body to be string or array, '
102	1		. 'got ' . gettype($body));
103			}
104	5		$this->body = $body;
105	5		}
106
107			/**
108			* @return array
109			*/
110	5		public function jsonSerialize() : array
111			{
112			return [
113	5		IResponse::TYPE_IS => [
114	5		'statusCode' => $this->getStatusCode(),
115	5		'headers' => $this->getHeaders(),
116	5		'body' => $this->getBody(),
117	5		'_mode' => $this->getMode(),
118			],
119			];
120			}
121
122			/**
123			* @return int
124			*/
125	7		public function getStatusCode() : int
126			{
127	7		return $this->statusCode;
128			}
129
130			/**
131			* @param int $status_code
132			*/
133	28		public function setStatusCode(int $status_code)
134			{
135	28		$this->statusCode = $status_code;
136	28		}
137
138			/**
139			* @return array
140			*/
141	8		public function getHeaders() : array
142			{
143	8		return $this->headers;
144			}
145
146			/**
147			* TODO headers with same name
148			*
149			* @param array $headers ['name' => 'value', ..]
150			*/
151	28		public function setHeaders(array $headers)
152			{
153	28		foreach ($headers as $name => $value) {
154	6		$this->setHeader($name, $value);
155			}
156	28		}
157
158			/**
159			* @return string
160			*/
161	7		public function getMode() : string
162			{
163	7		return $this->mode;
164			}
165
166			/**
167			* @param string $mode
168			*/
169	4	View Code Duplication	public function setMode(string $mode)
			0 ignored issues – show Duplication introduced 2016-08-16 22:47 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...
170			{
171	4		if (!in_array($mode, [self::MODE_TEXT, self::MODE_BINARY])) {
172	1		throw new \InvalidArgumentException("Unable to set IsResponse mode; Invalid mode: '$mode'");
173			}
174	3		$this->mode = $mode;
175	3		}
176
177			/**
178			* @return string
179			*/
180	3		public function getType() : string
181			{
182	3		return $this->type;
183			}
184
185			/**
186			* @param string $name
187			* @param string $value
188			*/
189	6		public function setHeader($name, $value)
190			{
191	6		if (!is_string($name)) {
192	1		throw new \InvalidArgumentException(
193			'Unable to set IsResponse headers; Header name expected be string, '
194	1		. gettype($name) . " received ('" . (string)$name . "')"
195			);
196			}
197	5		$this->headers[$name] = $value;
198	5		}
199
200			/**
201			* @param string $name
202			* @return mixed\|null
203			*/
204	1		public function getHeader($name)
205			{
206	1		return isset($this->headers[$name]) ? $this->headers[$name] : null;
207			}
208			}
209

meare / juggler

Push — master ( 816792...074308 )

IsResponse::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like