rspec/rules/S1862/scala/rule.adoc

75 lines
1.6 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
A ``++match++`` and a chain of ``++if++``/``++else if++`` statements is evaluated from top to bottom. At most, only one branch will be executed: the first one with a condition that evaluates to ``++true++``.
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
Therefore, duplicating a condition automatically leads to dead code. Usually, this is due to a copy/paste error. At best, it's simply dead code and at worst, it's a bug that is likely to induce further bugs as the code is maintained, and obviously it could lead to unexpected behavior.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
For a ``++match++``, the second ``++case++`` will never be executed, rendering it dead code. Worse there is the risk in this situation that future maintenance will be done on the dead case, rather than on the one that's actually used.
2020-06-30 12:47:33 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,scala]
2020-06-30 12:47:33 +02:00
----
if (param == 1) {
openWindow
} else if (param == 2) {
closeWindow
} else if (param == 1) { // Noncompliant
moveWindowToTheBackground
}
param match {
case 1 =>
// ...
case 3 =>
// ...
case 1 => // Noncompliant
// ...
case _ =>
//...
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,scala]
2020-06-30 12:47:33 +02:00
----
if (param == 1) {
openWindow
} else if (param == 2) {
closeWindow
} else if (param == 3) {
moveWindowToTheBackground
}
param match {
case 1 =>
// ...
case 3 =>
// ...
case _ =>
//...
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]