rspec/rules/S126/ruby/rule.adoc

51 lines
1.3 KiB
Plaintext
Raw Normal View History

2021-01-27 13:42:22 +01:00
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.
2020-06-30 10:16:44 +02:00
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
The requirement for a final ``++else++`` statement is defensive programming.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
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.
2020-06-30 10:16:44 +02:00
== Noncompliant Code Example
2022-02-04 17:28:24 +01:00
[source,ruby]
2020-06-30 10:16:44 +02:00
----
if x == 0
doSomething
elsif x == 1
doSomethingElse
end
----
== Compliant Solution
2022-02-04 17:28:24 +01:00
[source,ruby]
2020-06-30 10:16:44 +02:00
----
if x == 0
doSomething
elsif x == 1
doSomethingElse
else
raise 'An error has occured'
end
----
== Exceptions
2021-01-27 13:42:22 +01:00
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[]