51369b610e
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.
54 lines
1.3 KiB
Plaintext
54 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
This rule applies whenever an ``++if++`` statement is followed by one or more ``++elsif++`` statements; the final ``++elsif++`` should be followed by an ``++else++`` statement.
|
|
|
|
|
|
The requirement for a final ``++else++`` statement is defensive programming.
|
|
|
|
The ``++else++`` statement should either take appropriate action or contain a suitable comment as to why no action is taken. This is consistent with the requirement to have a final ``++else++`` clause in a ``++case++`` statement.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,ruby]
|
|
----
|
|
if x == 0
|
|
doSomething
|
|
elsif x == 1
|
|
doSomethingElse
|
|
end
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,ruby]
|
|
----
|
|
if x == 0
|
|
doSomething
|
|
elsif x == 1
|
|
doSomethingElse
|
|
else
|
|
raise 'An error has occured'
|
|
end
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
When all branches of an ``++if++``-``++else if++`` end with ``++return++``, ``++break++`` or ``++throw++``, the code that comes after the ``++if++`` implicitly behaves as if it was in an ``++else++`` clause. This rule will therefore ignore that case.
|
|
|
|
|
|
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[]
|