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-11 11:41:24 +02:00
|
|
|
=== Exceptions
|
|
|
|
|
|
|
|
No issue will be raised on:
|
|
|
|
|
|
|
|
* strings with less than 5 characters
|
|
|
|
* strings with only letters, numbers, underscores, hyphens and periods
|
|
|
|
|
|
|
|
== How to fix it
|
|
|
|
|
|
|
|
include::../howtofix.adoc[]
|
|
|
|
|
|
|
|
=== Code examples
|
|
|
|
|
|
|
|
==== Noncompliant code example
|
2020-06-30 12:47:33 +02:00
|
|
|
|
|
|
|
With the default threshold of 3:
|
2020-06-30 14:49:38 +02:00
|
|
|
|
2023-10-11 11:41:24 +02:00
|
|
|
[source,php,diff-id=1,diff-type=noncompliant]
|
2020-06-30 12:47:33 +02:00
|
|
|
----
|
|
|
|
function run() {
|
2022-09-28 15:50:26 +02:00
|
|
|
prepare('this is a duplicate'); // Noncompliant - 'this is a duplicate' is duplicated 3 times
|
2020-06-30 14:49:38 +02:00
|
|
|
execute('this is a duplicate');
|
|
|
|
release('this is a duplicate');
|
2020-06-30 12:47:33 +02:00
|
|
|
}
|
|
|
|
----
|
|
|
|
|
2023-10-11 11:41:24 +02:00
|
|
|
==== Compliant solution
|
2020-06-30 12:47:33 +02:00
|
|
|
|
2023-10-11 11:41:24 +02:00
|
|
|
[source,php,diff-id=1,diff-type=compliant]
|
2020-06-30 12:47:33 +02:00
|
|
|
----
|
2020-06-30 14:49:38 +02:00
|
|
|
MESSAGE = 'this is a duplicate';
|
2020-06-30 12:47:33 +02:00
|
|
|
|
|
|
|
function run() {
|
2023-10-11 11:41:24 +02:00
|
|
|
prepare(MESSAGE); // Compliant - the duplicated string literal is replaced by a constant and can be safely re-used
|
2020-06-30 14:49:38 +02:00
|
|
|
execute(MESSAGE);
|
|
|
|
release(MESSAGE);
|
2020-06-30 12:47:33 +02:00
|
|
|
}
|
|
|
|
----
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
[source,php]
|
2020-06-30 14:49:38 +02:00
|
|
|
----
|
2022-09-28 15:50:26 +02:00
|
|
|
$severity = $request->getParam('severity-score');
|
2020-06-30 14:49:38 +02:00
|
|
|
----
|
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::../parameters.adoc[]
|
|
|
|
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2023-05-25 14:18:12 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|