Add Method addTips() to Rule to

[verfriemelt-dot-org]

This allows to add reasoning about any given rule via the addTips() implementation of PHPStan.

consider the following rule

    public function test_no_concrete_repository(): Rule
    {
        return PHPat::rule()
            ->classes(Selector::namespace('\\Foo\\Bar'))
            ->shouldNotDependOn()
            ->classes(
                Selector::namespace('\\Foo\\Bar\\Repository'),
            )
            ->because(
                'you should instead depend on an abstraction!',
                'its for your own good!'
            )
        ;
    }

which would yield

 ------ ------------------------------------------------------------------------------------------------
  Line   src/Domain/Entity/LineImportService.php
 ------ ------------------------------------------------------------------------------------------------
  12     Foo\Bar\Domain\Entity\LineImportService should not depend on \Foo\Bar\Repository
         💡 you should instead depend on an abstraction!
         💡 its for your own good!

 ------ ------------------------------------------------------------------------------------------------

this can add value via reasons or alternative approaches or generic tips.

[carlosas]

Requested some changes :)
Also missing a test (with no tips, with one tip, with more than one tip)

[verfriemelt-dot-org]

i tried to implement your suggestions and added an example in the README.md as well.
let me know if i can improve something :)

[carlosas]

It's working well for Relation Assertions (depend on, extend...), but it's missing for Declaration Assertions (is final, is abstract...)

In AssertionStep, those assertion methods should be like:

public function shouldBeFinal(): TipOrBuildStep
{
    $this->rule->assertion = ShouldBeFinal::class;

    return new TipOrBuildStep($this->rule);
}

and also src/Rule/Assertion/Declaration/ValidationTrait.php should build the error with the tips, like src/Rule/Assertion/Relation/ValidationTrait.php does :)

---

The CI checks give an error because the php-cs-fixer configuration includes a rule that breaks on PHP 7.4. I will update the config now. Please, rebase or merge from master and edit src/Test/TestExtractor.php (line 35) manually back to:

$reflectedTest = $this->reflectTest(get_class($test));

[verfriemelt-dot-org]

and also src/Rule/Assertion/Declaration/ValidationTrait.php should build the error with the tips, like src/Rule/Assertion/Relation/ValidationTrait.php does

that makes sense :) i'll fix that

[verfriemelt-dot-org]

i thought about using a generator and basically test every method for the ValidationTraits ... but that would be more or less a full duplicate of all the other testcases and not really diserable 🤔 what do you think?

[carlosas]

i thought about using a generator and basically test every method for the ValidationTraits ... but that would be more or less a full duplicate of all the other testcases and not really diserable 🤔 what do you think?

the current tests are good enough :) merging and will deploy soon together with a couple of new features
sorry for the delay! 🌴

[verfriemelt-dot-org]

yay 🎉 thanks for merging that :)

[carlosas]

thanks for the contribution 🙂