Modify S1192: Migrate to LayC (#3234)

SonarSource · Oct 11, 2023 · a117458 · a117458
1 parent 44f4c80
commit a117458
Show file tree

Hide file tree

Showing 22 changed files with 277 additions and 264 deletions.
diff --git a/rules/S1192/abap/rule.adoc b/rules/S1192/abap/rule.adoc
@@ -1,12 +1,12 @@
-== Why is this an issue?
+include::../rule.adoc[]
 
-include::../description.adoc[]
+=== Code examples
 
-=== Noncompliant code example
+==== Noncompliant code example
 
 With the default threshold of 3:
 
-[source,abap]
+[source,abap,diff-id=1,diff-type=noncompliant]
 ----
 WRITE: / 'Firstname'.
 *...
@@ -15,9 +15,9 @@ WRITE: / 'Firstname'.
 WRITE: / 'Firstname'.
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,abap]
+[source,abap,diff-id=1,diff-type=compliant]
 ----
 CONSTANTS: fname    TYPE c LENGTH 9 VALUE 'Firstname',
 
@@ -28,8 +28,6 @@ WRITE: / fname.
 WRITE: / fname.
 ----
 
-include::../exceptions.adoc[]
-
 ifdef::env-github,rspecator-view[]
 
 '''
@@ -43,9 +41,5 @@ include::../parameters.adoc[]
 include::../highlighting.adoc[]
 
 '''
-== Comments And Links
-(visible only on this page)
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
diff --git a/rules/S1192/apex/rule.adoc b/rules/S1192/apex/rule.adoc
@@ -2,9 +2,19 @@
 
 include::../description.adoc[]
 
-=== Noncompliant code example
+=== Exceptions
+
+To prevent generating some false-positives, literals having 5 or less characters are excluded as well as literals containing only letters, digits and '_'.
+
+== How to fix it
+
+include::../howtofix.adoc[]
+
+=== Code examples
 
-[source,apex]
+==== Noncompliant code example
+
+[source,apex,diff-id=1,diff-type=noncompliant]
 ----
 class A {
     void doSomething(String msg) {
@@ -21,9 +31,9 @@ class A {
 }
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,apex]
+[source,apex,diff-id=1,diff-type=compliant]
 ----
 class A {
     static final String STRING_CONST = 'string literal';
@@ -36,9 +46,6 @@ class A {
 }
 ----
 
-=== Exceptions
-
-To prevent generating some false-positives, literals having 5 or less characters are excluded as well as literals containing only letters, digits and '_'.
 
 ifdef::env-github,rspecator-view[]
 
@@ -53,9 +60,5 @@ include::../parameters.adoc[]
 include::../highlighting.adoc[]
 
 '''
-== Comments And Links
-(visible only on this page)
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
diff --git a/rules/S1192/cobol/rule.adoc b/rules/S1192/cobol/rule.adoc
@@ -2,11 +2,23 @@
 
 include::../description.adoc[]
 
-=== Noncompliant code example
+=== Exceptions
+
+Literals with fewer than 7 characters are ignored.
+
+Only duplications located in a `PROCEDURE DIVISION`, not those contained in copybooks are reported.
+
+== How to fix it
+
+include::../howtofix.adoc[]
+
+=== Code examples
+
+==== Noncompliant code example
 
 With the default threshold of 3:
 
-[source,cobol]
+[source,cobol,diff-id=1,diff-type=noncompliant]
 ----
        PROCEDURE DIVISION.
 
@@ -17,9 +29,9 @@ With the default threshold of 3:
        DISPLAY "Firstname: ".
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,cobol]
+[source,cobol,diff-id=1,diff-type=compliant]
 ----
        WORKING-STORAGE SECTION.
          01 FIRST-NAME-HEADER PIC X(42) VALUE "Firstname: ".
@@ -32,13 +44,6 @@ With the default threshold of 3:
        DISPLAY FIRST-NAME-HEADER
 ----
 
-=== Exceptions
-
-Literals with fewer than 7 characters are ignored.
-
-
-Only duplications located in a ``++PROCEDURE DIVISION++``, not those contained in copybooks are reported.
-
 ifdef::env-github,rspecator-view[]
 
 '''
@@ -52,9 +57,5 @@ include::../parameters.adoc[]
 include::../highlighting.adoc[]
 
 '''
-== Comments And Links
-(visible only on this page)
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
diff --git a/rules/S1192/comments-and-links.adoc b/rules/S1192/comments-and-links.adoc
diff --git a/rules/S1192/csharp/rule.adoc b/rules/S1192/csharp/rule.adoc
@@ -2,9 +2,23 @@
 
 include::../description.adoc[]
 
-=== Noncompliant code example
+=== Exceptions
+
+The following are ignored:
+
+* literals with fewer than 5 characters
+* literals matching one of the parameter names
+* literals used in attributes
+
+== How to fix it
+
+include::../howtofix.adoc[]
 
-[source,csharp]
+=== Code examples
+
+==== Noncompliant code example
+
+[source,csharp,diff-id=1,diff-type=noncompliant]
 ----
 public class Foo
 {
@@ -19,9 +33,9 @@ public class Foo
 }
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,csharp]
+[source,csharp,diff-id=1,diff-type=compliant]
 ----
 public class Foo
 {
@@ -38,14 +52,6 @@ public class Foo
 }
 ----
 
-=== Exceptions
-
-The following are ignored:
-
-* literals with fewer than 5 characters
-* literals matching one of the parameter names
-* literals used in attributes
-
 ifdef::env-github,rspecator-view[]
 
 '''
@@ -67,15 +73,5 @@ secondaries: all instances of the string literal
 
 
 '''
-== Comments And Links
-(visible only on this page)
-
-=== on 21 Mar 2018, 15:11:26 Amaury Levé wrote:
-Could you review this sub-task please?
-
-=== on 21 Mar 2018, 15:33:08 Ann Campbell wrote:
-I think a brief code example would be helpful for the second item, [~amaury.leve].
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
diff --git a/rules/S1192/description.adoc b/rules/S1192/description.adoc
@@ -1,3 +1 @@
-Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.
-
-On the other hand, constants can be referenced from many places, but only need to be updated in a single place.
+Duplicated string literals make the process of refactoring complex and error-prone, as any change would need to be propagated on all occurrences.
diff --git a/rules/S1192/exceptions.adoc b/rules/S1192/exceptions.adoc
@@ -1,3 +1 @@
-=== Exceptions
-
 To prevent generating some false-positives, literals having less than 5 characters are excluded.
diff --git a/rules/S1192/go/rule.adoc b/rules/S1192/go/rule.adoc
@@ -2,11 +2,21 @@
 
 include::../description.adoc[]
 
-=== Noncompliant code example
+=== Exceptions
+
+To prevent generating some false-positives, literals having 5 or less characters are excluded as well as literals containing only letters, digits and '_'.
+
+== How to fix it
+
+include::../howtofix.adoc[]
+
+=== Code examples
+
+==== Noncompliant code example
 
 With the default threshold of 3:
 
-[source,go]
+[source,go,diff-id=1,diff-type=noncompliant]
 ----
 func run() {                                                                                      
 	prepare("This should be a constant")  // Noncompliant; 'This should ...' is duplicated 3 times
@@ -15,9 +25,9 @@ func run() {
 }
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,go]
+[source,go,diff-id=1,diff-type=compliant]
 ----
 const ACTION = "This should be a constant"
 
@@ -28,10 +38,6 @@ func run() {
 }
 ----
 
-=== Exceptions
-
-To prevent generating some false-positives, literals having 5 or less characters are excluded as well as literals containing only letters, digits and '_'.
-
 ifdef::env-github,rspecator-view[]
 
 '''
@@ -45,9 +51,5 @@ include::../parameters.adoc[]
 include::../highlighting.adoc[]
 
 '''
-== Comments And Links
-(visible only on this page)
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
diff --git a/rules/S1192/howtofix.adoc b/rules/S1192/howtofix.adoc
@@ -0,0 +1,2 @@
+Instead, use constants to replace the duplicated string literals.
+Constants can be referenced from many places, but only need to be updated in a single place.
diff --git a/rules/S1192/java/rule.adoc b/rules/S1192/java/rule.adoc
@@ -1,12 +1,12 @@
-== Why is this an issue?
+include::../rule.adoc[]
 
-include::../description.adoc[]
+=== Code examples
 
-=== Noncompliant code example
+==== Noncompliant code example
 
 With the default threshold of 3:
 
-[source,java]
+[source,java,diff-id=1,diff-type=noncompliant]
 ----
 public void run() {
   prepare("action1");                              // Noncompliant - "action1" is duplicated 3 times
@@ -19,15 +19,14 @@ private void method1() { /* ... */ }
 @SuppressWarning("all")
 private void method2() { /* ... */ }
 
-public String method3(String a) {
-  System.out.println("'" + a + "'");               // Compliant - literal "'" has less than 5 characters and is excluded
-  return "";                                       // Compliant - literal "" has less than 5 characters and is excluded
+public String printInQuotes(String a, String b) {
+  return "'" + a + "'" + b + "'";               // Compliant - literal "'" has less than 5 characters and is excluded
 }
 ----
 
-=== Compliant solution
+==== Compliant solution
 
-[source,java]
+[source,java,diff-id=1,diff-type=compliant]
 ----
 private static final String ACTION_1 = "action1";  // Compliant
 
@@ -38,8 +37,6 @@ public void run() {
 }
 ----
 
-include::../exceptions.adoc[]
-
 ifdef::env-github,rspecator-view[]
 
 '''
@@ -53,9 +50,5 @@ include::../parameters.adoc[]
 include::../highlighting.adoc[]
 
 '''
-== Comments And Links
-(visible only on this page)
-
-include::../comments-and-links.adoc[]
 
 endif::env-github,rspecator-view[]
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1 @@
		=== Exceptions

		To prevent generating some false-positives, literals having less than 5 characters are excluded.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Instead, use constants to replace the duplicated string literals.
		Constants can be referenced from many places, but only need to be updated in a single place.