Ability to combine assertions

[calebdw]

Enhancement description

Hello!

I'm trying to write enforce that a domain object be both final and readonly but there does not seem to be a way to do this in the same test...

    public function testDomainObjectsAreFinalAndReadonly(): Rule
    {
        return PHPat::rule()
            ->classes(Selector::inNamespace('/.*\\\\DomainObjects/', regex: true))
            ->shouldBeFinal();
    }

Suggested approach or solution

I'm not sure what a good api would be...the ability to chain the assertions would be the easiest from the end user's perspective but maybe not so much the developer's haha.

    public function testDomainObjectsAreFinalAndReadonly(): Rule
    {
        return PHPat::rule()
            ->classes(Selector::inNamespace('/.*\\\\DomainObjects/', regex: true))
            ->shouldBeFinal()
            ->shouldBeReadonly();
    }

I've also seen ->and() used before (like in Pest)

    public function testDomainObjectsAreFinalAndReadonly(): Rule
    {
        return PHPat::rule()
            ->classes(Selector::inNamespace('/.*\\\\DomainObjects/', regex: true))
            ->shouldBeFinal()
            ->and()
            ->shouldBeReadonly();
    }

Thanks!

[carlosas]

Sounds good. The API shoud be like that for declaration assertions (X should be final...), also should work with relation assertions (X should extend Y...) and it should allow to add as many assertions as needed.

Something like:

public function testDomainObjectsAreFinalAndReadonly(): Rule
{
    return PHPat::rule()
        ->classes(Selector::inNamespace('/.*\\\\DomainObjects/', regex: true))
        ->shouldNotDependOn()
        ->classes(Selector::inNamespace('/.*\\\\Whatever/', regex: true))
        ->excluding(Selector::implements(SomeInterface::class))
        ->and()
        ->shouldNotExtend()
        ->classes(Selector::classname(SomeAbstractClass::class))
        ->and()
        ->shouldBeReadonly();
}

I don't know how easy will be doing the trick with the builder steps, it's already tricky enough 😅

I will be offline until next weekend. I will think about it but I'm sure it's doable. Also open for a PR :)

[calebdw]

That's a good idea, should there also be an or method (does that even make sense in this context)?

[carlosas]

That would over-complicate it, let's leave it in and() for now 👍