Add a rule about abstract test case

[soullivaneuh]

Public test cases should not be prefixed by Abstract. See sonata-project/SonataBlockBundle#425

We should add an entry to the guide about this.

[greg0ire]

Why not?

[soullivaneuh]

As usual, we follow SF coding style and no Abstract prefix is used on Symfony, neither on PHPUnit.

Sample: https://github.com/symfony/symfony/blob/ba3b17719272e614732a3d1323b556cf32da8dfb/src/Symfony/Component/Form/Test/TypeTestCase.php#L18

[greg0ire]

Ok 👍
But do you know why they did that?

[soullivaneuh]

@greg0ire I guess to follow PHPUnit convention about this part?

[greg0ire]

probably

[jlamur]

Is prefixing abstract classes with Abstract a PSR rule or a SF rule?
I thought I've read it but I can't find it on the PSR.
I can even find an example on the PSR-2 where an abstract class is not prefixed with Abstract: http://www.php-fig.org/psr/psr-2/#45-abstract-final-and-static

[jlamur]

It's a SF rule: http://symfony.com/doc/current/contributing/code/standards.html#naming-conventions

Prefix abstract classes with Abstract. Please note some early Symfony classes do not follow this convention and have not been renamed for backward compatibility reasons. However all new abstract classes must follow this naming convention;

[jlamur]

@soullivaneuh You probably found a class that was created too early to comply with the SF rule.

This class, for example, follow the convention: https://github.com/symfony/symfony/blob/ba3b17719272e614732a3d1323b556cf32da8dfb/src/Symfony/Component/Form/Tests/AbstractTableLayoutTest.php

[soullivaneuh]

@jlamur Your example is not a test re-usable test case, see the namespace.

It's a SF rule

Yes, but clearly not for test case. The official documentation may be updated for it in this case.

[soullivaneuh]

[greg0ire]

Yes, but clearly not for test case. The official documentation may be updated for it in this case.

Please make a docs PR first, so that we know what this is about, and if it is indeed a good practice.

[soullivaneuh]

Please make a docs PR first, so that we know what this is about

AFAIK, the incomplete doc is a hermetic issue, you can clearly see that the Abstract prefix is not used for test cases.

[soullivaneuh]

I'll open an issue about missing documentation, but this change nothing for this one.

[greg0ire]

I don't think we should blindly adopt de facto standards as found in the code. Especially if we are unsure what reasons that lead to them.

[soullivaneuh]

We are not talking about a single test case class having this name format here and some are recent. It's clear it's not a mistake.