rspec/rules/S1751/tsql/rule.adoc

69 lines
1.4 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
A ``++WHILE++`` loop with at most one iteration is equivalent to the use of an ``++IF++`` statement to conditionally execute one piece of code. No developer expects to find such usage of a loop statement. If the initial intention of the author was really to conditionally execute one piece of code, an ``++IF++`` statement should be used in place.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
At worst that was not the initial intention of the author and so the body of the loop should be fixed to use the nested ``++RETURN++``, ``++BREAK++`` or ``++THROW++`` statements in a more appropriate way.
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,sql]
2020-06-30 12:47:33 +02:00
----
WHILE @cond -- noncompliant, loop only executes once
BEGIN
EXEC something;
BREAK;
END;
...
WHILE @cond1 -- noncompliant, loop only executes once
BEGIN
IF @cond2
BEGIN
EXEC something;
BREAK;
END ELSE
BEGIN
RETURN @value;
END;
END;
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,sql]
2020-06-30 12:47:33 +02:00
----
IF @cond
BEGIN
EXEC something;
BREAK;
END;
...
WHILE @cond
BEGIN
IF @cond2
BEGIN
EXEC something;
END ELSE
BEGIN
RETURN @value;
END;
END;
----
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[]