Zenstruck\Browser\Response

Complexity

Total Complexity

25

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	2

14 Methods

Rating	Name	Duplication	Size	Complexity
A	statusCode()	0	3	1
A	isRedirect()	0	3	2
A	__construct()	0	3	1
A	assertJson()	0	7	2
A	assertHtml()	0	7	2
A	session()	0	3	1
A	rawBody()	0	3	1
A	assertXml()	0	7	2
A	dump()	0	7	2
A	raw()	0	3	1
A	rawMetadata()	0	11	3
A	isSuccessful()	0	3	2
A	body()	0	3	1
A	createFor()	0	17	4

<?php

namespace Zenstruck\Browser;

use Behat\Mink\Session;
use PHPUnit\Framework\Assert as PHPUnit;

The type PHPUnit\Framework\Assert was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\VarDumper\VarDumper;
use Zenstruck\Browser\Response\HtmlResponse;
use Zenstruck\Browser\Response\JsonResponse;
use Zenstruck\Browser\Response\XmlResponse;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
class Response
{
    private Session $session;

    /**
     * @internal
     */
    final public function __construct(Session $session)
    {
        $this->session = $session;
    }

    final public function statusCode(): int
    {
        return $this->session->getStatusCode();
    }

    /**
     * @internal
     */
    final public static function createFor(Session $session): self
    {
        $contentType = (string) $session->getResponseHeader('content-type');

        if (str_contains($contentType, 'json')) {
            return new JsonResponse($session);
        }

        if (str_contains($contentType, 'html')) {
            return new HtmlResponse($session);
        }

        if (str_contains($contentType, 'xml')) {
            return new XmlResponse($session);
        }

        return new self($session);
    }

    final public function body(): string
    {
        return $this->session->getPage()->getContent();
    }

    final public function assertJson(): JsonResponse
    {
        if (!$this instanceof JsonResponse) {
            PHPUnit::fail('Not a json response.');
        }

        return $this;

The expression return $this returns the type Zenstruck\Browser\Response which includes types incompatible with the type-hinted return Zenstruck\Browser\Response\JsonResponse.

    }

    final public function assertXml(): XmlResponse
    {
        if (!$this instanceof XmlResponse) {
            PHPUnit::fail('Not an xml response.');
        }

        return $this;

The expression return $this returns the type Zenstruck\Browser\Response which includes types incompatible with the type-hinted return Zenstruck\Browser\Response\XmlResponse.

    }

    final public function assertHtml(): HtmlResponse
    {
        if (!$this instanceof HtmlResponse) {
            PHPUnit::fail('Not an html response.');
        }

        return $this;

The expression return $this returns the type Zenstruck\Browser\Response which includes types incompatible with the type-hinted return Zenstruck\Browser\Response\HtmlResponse.

    }

    /**
     * @internal
     */
    final public function raw(): string
    {
        return "{$this->rawMetadata()}\n{$this->rawBody()}";
    }

    /**
     * @internal
     */
    final public function isSuccessful(): bool
    {
        return $this->statusCode() >= 200 && $this->statusCode() < 300;
    }

    /**
     * @internal
     */
    final public function isRedirect(): bool
    {
        return $this->statusCode() >= 300 && $this->statusCode() < 400;
    }

    /**
     * @internal
     */
    public function dump(?string $selector = null): void
    {
        if (null !== $selector) {
            throw new \LogicException('$selector cannot be used with this response type.');
        }

        VarDumper::dump($this->raw());
    }

    /**
     * @internal
     */
    final protected function session(): Session
    {
        return $this->session;
    }

    /**
     * @internal
     */
    protected function rawMetadata(): string
    {
        $ret = "URL: {$this->session->getCurrentUrl()} ({$this->statusCode()})\n\n";

        foreach ($this->session->getResponseHeaders() as $header => $values) {
            foreach ($values as $value) {
                $ret .= "{$header}: {$value}\n";
            }
        }

        return $ret;
    }

    /**
     * @internal
     */
    protected function rawBody(): string
    {
        return $this->body();
    }
}