rspec/rules/S2187/php/rule.adoc
Fred Tingaud 51369b610e
Make sure that includes are always surrounded by empty lines (#2270)
When an include is not surrounded by empty lines, its content is inlined
on the same line as the adjacent content. That can lead to broken tags
and other display issues.
This PR fixes all such includes and introduces a validation step that
forbids introducing the same problem again.
2023-06-22 10:38:01 +02:00

69 lines
1.2 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
There's no point in having a PHPUnit test case without any test methods. Similarly, you shouldn't have a file in the tests directory which extends PHPUnit\Framework\TestCase but no tests in the file. Doing either of these things may lead someone to think that uncovered classes have been tested. Add some test method or make the class abstract if it is used by a real test case class.
=== Noncompliant code example
[source,php]
----
use PHPUnit\Framework\TestCase;
class MyTest extends TestCase {
protected function setUp() {
doSomethind();
}
private function doSomethind() {
//...
}
}
----
=== Compliant solution
[source,php]
----
use PHPUnit\Framework\TestCase;
class MyTest extends TestCase {
public function testBehaviour() {
//...
}
//...
} 
// or
abstract class MyAbstractTest extends TestCase {
protected function setUp() {
doSomethind();
}
private function doSomethind() {
//...
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]