TestView::assertSeeTimes() - Code Metrics - Inspection of "Merge pull request #1613 from hydephp/improved-vie..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( eaf66d...5fa21f )

by Caen
created 2024-03-17 18:14 UTC
TestView::assertSeeTimes() A

↳ Parent: TestView
Complexity

Conditions	1
Paths	1
Size

Total Lines	9
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
cc	1
eloc	4
c	2
b	0
f	0
nc	1
nop	2
dl	0
loc	9
rs	10
<?php

declare(strict_types=1);

namespace Hyde\Testing\Support;

use Hyde\Hyde;
use Illuminate\Support\Str;
use JetBrains\PhpStorm\NoReturn;
use Illuminate\Testing\Assert as PHPUnit;

/**
 * @todo Unify API with the TestableHtmlDocument and TestableHtmlElement classes.
 */
class TestView extends \Illuminate\Testing\TestView
{
    /**
     * Assert that the given HTML is contained within the view.
     *
     * @return $this
     */
    public function assertSeeHtml(string $value, bool $ignoreFormatting = false): static
    {
        if ($ignoreFormatting) {
            return $this->assertSeeHtmlIgnoringFormatting($value);
        }

        return $this->assertSee($value, false);
    }

    /**
     * Assert that the given HTML is contained within the view text, ignoring whitespace and newlines.
     *
     * @return $this
     */
    public function assertSeeHtmlIgnoringFormatting(string $value): static
    {
        PHPUnit::assertStringContainsString($this->trimNewlinesAndIndentation($value), $this->trimNewlinesAndIndentation($this->rendered));

        return $this;
    }

    /**
     * Assert that the given string is contained exactly `$times` within the view.
     *
     * @return $this
     */
    public function assertSeeTimes(string $value, int $times = 1): static
    {
        $this->assertSee($value, false);

        $count = substr_count($this->rendered, $value);

        PHPUnit::assertSame($times, $count, "The string '$value' was found $count times, expected $times.");

        return $this;
    }

    /**
     * Assert that the given string is contained exactly once within the view.
     *
     * @return $this
     */
    public function assertSeeOnce(string $value): static
    {
        return $this->assertSeeTimes($value);
    }

    /**
     * Assert that the given HTML element is contained within the view.
     *
     * @return $this
     */
    public function assertHasElement(string $element): static
    {
        $element = trim($element, '</>');

        if (str_starts_with($element, '#')) {
            return $this->assertHasId($element);
        }

        PHPUnit::assertStringContainsString("<$element", $this->rendered, "The element '$element' was not found.");

        return $this;
    }

    /**
     * Assert that the HTML attribute value is contained within the view.
     *
     * @return $this
     */
    public function assertAttributeIs(string $attribute, ?string $expectedValue = null): static
    {
        if ($expectedValue === null) {
            [$attributeName, $expectedValue] = explode('=', $attribute);
            $expectedValue = trim($expectedValue, '"');
        } else {
            $attributeName = $attribute;
        }

        static::assertHasAttribute($attributeName);
                assertHasAttribute($attributeName);

        PHPUnit::assertStringContainsString($attributeName.'="'.$expectedValue.'"', $this->rendered, "The attribute '$attributeName' with value '$expectedValue' was not found.");

        return $this;
    }

    /**
     * Assert that the HTML attribute is present within the view.
     *
     * @return $this
     */
    public function assertHasAttribute(string $attributeName): static
    {
        PHPUnit::assertStringContainsString($attributeName.'="', $this->rendered, "The attribute '$attributeName' was not found.");

        return $this;
    }

    /**
     * Assert that the HTML attribute is not present within the view.
     *
     * @return $this
     */
    public function assertDoesNotHaveAttribute(string $attributeName): static
    {
        PHPUnit::assertStringNotContainsString($attributeName.'="', $this->rendered, "The attribute '$attributeName' was found.");

        return $this;
    }

    /**
     * Assert that the given HTML ID is contained within the view.
     *
     * @return $this
     */
    public function assertHasId(string $id): static
    {
        $id = trim($id, '#');

        PHPUnit::assertStringContainsString("id=\"$id\"", $this->rendered, "The id '$id' was not found.");

        return $this;
    }

    /**
     * Assert that the given CSS class is contained within the view.
     *
     * @return $this
     */
    public function assertHasClass(string $class): static
    {
        PHPUnit::assertContains($class, $this->findClasses(), "The class '$class' was not found.");

        return $this;
    }

    /**
     * Assert that the given CSS class is not contained within the view.
     *
     * @return $this
     */
    public function assertDoesNotHaveClass(string $class): static
    {
        PHPUnit::assertNotContains($class, $this->findClasses(), "The class '$class' was found.");

        return $this;
    }

    /**
     * Assert that the given text is equals the view's text content.
     *
     * @return $this
     */
    public function assertTextIs(string $value): static
    {
        PHPUnit::assertSame($value, strip_tags($this->rendered));

        return $this;
    }

    #[NoReturn]
    public function dd(bool $writeHtml = true): void
    {
        if ($writeHtml) {
            $viewName = Str::after(Str::after(basename(class_basename($this->view->getName())), '.'), '.');
            file_put_contents(Hyde::path(Str::kebab($viewName.'.html')), $this->rendered);
        }

        exit(trim($this->rendered)."\n\n");

    }

    protected function trimNewlinesAndIndentation(string $value): string
    {
        return str_replace(['    ', "\t", "\n", "\r"], '', $value);
    }

    /** @return array<string> */
    protected function findClasses(): array
    {
        preg_match_all('/class="([^"]+)"/', $this->rendered, $matches);

        return explode(' ', $matches[1][0]);
    }
}

hydephp / develop

Push — master ( eaf66d...5fa21f )

TestView::assertSeeTimes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
