2023-05-03 11:06:20 +02:00
== Why is this an issue?
2020-06-30 12:47:33 +02:00
include::../description.adoc[]
2023-10-16 11:46:41 +02:00
Code like
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,ruby]
2020-06-30 12:47:33 +02:00
----
2023-10-16 11:46:41 +02:00
if a then
unless b then # Noncompliant
2020-06-30 12:47:33 +02:00
# ...
end
end
2023-10-16 11:46:41 +02:00
----
2020-06-30 12:47:33 +02:00
2023-10-16 11:46:41 +02:00
Will be more readable as
[source, ruby]
----
if a && !b then # Compliant
# ...
end
----
== How to fix it
If merging the conditions seems to result in a more complex code, extracting the condition or part of it in a named function or variable is a better approach to fix readability.
=== Code examples
==== Noncompliant code example
[source,ruby]
----
if !filename.nil?
if File.file?(filename) || File.directory?(filename) # Noncompliant
2020-06-30 12:47:33 +02:00
# ...
end
end
----
2023-10-16 11:46:41 +02:00
==== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,ruby]
2020-06-30 12:47:33 +02:00
----
def isFileOrDirectory(filename)
File.file?(filename) || File.directory?(filename)
end
# ...
2023-10-16 11:46:41 +02:00
if !filename.nil? && isFileOrDirectory(filename) # Compliant
2020-06-30 12:47:33 +02:00
# ...
end
----
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
include::../highlighting.adoc[]
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
2023-06-22 10:38:01 +02:00
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]