Clean code attributes and better descriptions complying with Sonar Coding rule guidelines

pom.xml

@@ -129,13 +129,54 @@
         <java.version>11</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
+        <!-- to prevent message: system modules path not set in conjunction with -source 11 -->
+        <maven.compiler.release>${java.version}</maven.compiler.release>
 
         <encoding>UTF-8</encoding>
         <project.build.sourceEncoding>${encoding}</project.build.sourceEncoding>
         <project.reporting.outputEncoding>${encoding}</project.reporting.outputEncoding>
 
-    </properties>
+        <sonar.organization>green-code-initiative</sonar.organization>
+        <sonar.host.url>https://sonarcloud.io</sonar.host.url>
 
+        <junit.jupiter.version>5.9.1</junit.jupiter.version>
+        <assertJ.version>3.23.1</assertJ.version>
+        <mockito.version>5.3.1</mockito.version>
+        <sonarqube.version>10.10.0.2391</sonarqube.version>
+        <sonar-analyzer-commons.version>2.12.0.2964</sonar-analyzer-commons.version>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.sonarsource.api.plugin</groupId>
+            <artifactId>sonar-plugin-api</artifactId>
+            <version>${sonarqube.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.sonarsource.analyzer-commons</groupId>
+            <artifactId>sonar-analyzer-commons</artifactId>
+            <version>${sonar-analyzer-commons.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertJ.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-junit-jupiter</artifactId>
+            <version>${mockito.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
     <build>
         <pluginManagement>
             <plugins>
@@ -148,6 +189,75 @@
             </plugins>
         </pluginManagement>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.1.2</version>
+            </plugin>
+            <plugin>
+                <groupId>com.mycila</groupId>
+                <artifactId>license-maven-plugin</artifactId>
+                <version>4.5</version>
+                <configuration>
+                    <properties>
+                        <owner>Green Code Initiative</owner>
+                        <email>https://green-code-initiative.org</email>
+                    </properties>
+                    <licenseSets>
+                        <licenseSet>
+                            <header>
+                                com/mycila/maven/plugin/license/templates/GPL-3.txt</header>
+                            <includes>
+                                <include>**/*.java</include>
+                            </includes>
+                        </licenseSet>
+                    </licenseSets>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>validate</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <phase>validate</phase>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.43.0</version>
+                <configuration>
+                    <java>
+                        <googleJavaFormat>
+                            <version>1.23.0</version>
+                        </googleJavaFormat>
+                    </java>
+                    <formats>
+                        <format>
+                            <includes>
+                                <include>src/**/*.json</include>
+                            </includes>
+                            <eclipseWtp>
+                                <type>JSON</type>
+                            </eclipseWtp>
+                            <endWithNewline></endWithNewline>
+                            <indent>
+                                <spaces>true</spaces>
+                                <spacesPerTab>2</spacesPerTab>
+                            </indent>
+                        </format>
+                    </formats>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <phase>process-sources</phase>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-enforcer-plugin</artifactId>

src/main/rules/GCI1/GCI1.json

@@ -1,5 +1,5 @@
 {
-  "title": "Avoid Spring repository call in loop or stream operations",
+  "title": "Spring repository should not be called in loop or stream operations",
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
@@ -9,8 +9,14 @@
   "tags": [
     "performance",
     "spring",
-    "eco-design",
+    "sustainability",
     "creedengo"
   ],
-  "defaultSeverity": "Minor"
+  "defaultSeverity": "Minor",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
+    },
+    "attribute": "EFFICIENT"
+  }
 }

src/main/rules/GCI1/java/GCI1.asciidoc

@@ -1,10 +1,16 @@
+:!sectids:
+
+== Why is this an issue?
+
 The use of Spring repository in a loop induces unnecessary calculations by the CPU and therefore superfluous energy consumption.
 Also, the use of Spring repository in a stream operation like "peek, forEach, forEachOrdered, map" induces unnecessary multiple access to the database instead of single batch call.
 
-== Non compliant Code Example
+== How to fix it
+=== Noncompliant code example
 
 [source,java]
 ----
+// Noncompliant
 private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 
 List<Employee> employees = new ArrayList<>();
@@ -19,6 +25,7 @@ for (Integer id: ids) {
 
 [source,java]
 ----
+// Noncompliant
 List<Employee> employees = new ArrayList<>();
 Stream stream = Stream.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 stream.forEach(id -> {
@@ -29,7 +36,7 @@ stream.forEach(id -> {
 });
 ----
 
-== Compliant Solution
+=== Compliant solution
 
 [source,java]
 ----
@@ -42,3 +49,7 @@ List<Employee> employees = employeeRepository.findAllById(ids);
 private final List<Integer> ids = Stream.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).toList();
 List<Employee> employees = employeeRepository.findAllById(ids);
 ----
+
+== Resources
+
+Reference/Validation is unknown.

src/main/rules/GCI10/GCI10.json

@@ -1,14 +1,21 @@
 {
-  "title": "Avoid using unoptimized vector images",
+  "title": "Unoptimized vector images should be avoided",
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
     "func": "Constant\/Issue",
     "constantCost": "60min"
   },
   "tags": [
-    "eco-design",
-    "creedengo"
+    "sustainability",
+    "creedengo",
+    "performance"
   ],
-  "defaultSeverity": "Minor"
+  "defaultSeverity": "Minor",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
+    },
+    "attribute": "EFFICIENT"
+  }
 }

src/main/rules/GCI10/python/GCI10.asciidoc

@@ -1,9 +1,15 @@
+:!sectids:
+
+== Why is this an issue?
+
 SVG images generated by common drawing softwares contains unnecessary data: calc layer, metadata, namespaces and comments.
 
-== Non compliant Code Example
+== How to fix it
+=== Noncompliant code example
 
 [source,xml]
 ----
+<!-- Noncompliant -->
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 <svg
     width="210mm"
@@ -31,11 +37,15 @@ SVG images generated by common drawing softwares contains unnecessary data: calc
 </svg>
 ----
 
-== Compliant Solution
+=== Compliant solution
 
 [source,xml]
 ----
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 210 297" width="210mm" height="297mm">
     <circle cx="104.02724" cy="152.19028" r="73.177132" style="fill:#ff00ff;stroke-width:0.264583"/>
 </svg>
 ----
+
+== Resources
+
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_036_fr.md[CNumR best practices (3rd edition) BP_036]

src/main/rules/GCI11/GCI11.json

@@ -1,23 +1,23 @@
 {
-  "title": "Disallow multiple access of same DOM element.",
+  "title": "DOM manipulation should be limited",
   "type": "CODE_SMELL",
-  "code": {
-    "impacts": {
-      "MAINTAINABILITY": "MEDIUM"
-    },
-    "attribute": "EFFICIENT"
-  },
   "status": "ready",
   "remediation": {
     "func": "Constant\/Issue",
     "constantCost": "5min"
   },
   "tags": [
     "creedengo",
-    "eco-design",
+    "sustainability",
     "performance"
   ],
   "defaultSeverity": "Major",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    },
+    "attribute": "EFFICIENT"
+  },
   "compatibleLanguages": [
     "JAVASCRIPT",
     "TYPESCRIPT"

src/main/rules/GCI11/javascript/GCI11.asciidoc

@@ -10,14 +10,19 @@ Assigning the DOM object to a variable not only improves performance but also en
 It makes the code more concise and self-explanatory.
 Developers reading the code can understand that the variable holds a reference to a specific DOM element, and its subsequent use is likely for multiple operations.
 
+== How to fix it
+=== Noncompliant code example
+
 Here's an example in JavaScript to illustrate this rule:
 
 [source,js,data-diff-id="2",data-diff-type="noncompliant"]
 ----
 const width = document.getElementById('block').clientWidth;
-const height = document.getElementById('block').clientHeight; // Non-compliant
+const height = document.getElementById('block').clientHeight; // Noncompliant
 ----
 
+=== Compliant solution
+
 [source,js,data-diff-id="1",data-diff-type="noncompliant"]
 ----
 const blockElement = document.getElementById('block'); // Compliant
@@ -32,5 +37,5 @@ In the second example, the DOM element reference is cached in the `blockElement`
 
 === Documentation
 
-- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CNUMR best practices] - Reduce DOM access via JavaScript
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CNumR best practices] - Reduce DOM access via JavaScript
 - https://developer.mozilla.org/en-US/docs/Learn/Performance/JavaScript#tips_for_writing_more_efficient_code[Mozilla Web Technology for Developers] - Tips for writing more efficient code

src/main/rules/GCI12/GCI12.json

@@ -1,23 +1,23 @@
 {
-  "title": "Disallow multiple style changes at once.",
+  "title": "Multiple style changes should be batched",
   "type": "CODE_SMELL",
-  "code": {
-    "impacts": {
-      "MAINTAINABILITY": "MEDIUM"
-    },
-    "attribute": "EFFICIENT"
-  },
   "status": "ready",
   "remediation": {
     "func": "Constant\/Issue",
     "constantCost": "10min"
   },
   "tags": [
     "creedengo",
-    "eco-design",
+    "sustainability",
     "performance"
   ],
   "defaultSeverity": "Major",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    },
+    "attribute": "EFFICIENT"
+  },
   "compatibleLanguages": [
     "JAVASCRIPT",
     "TYPESCRIPT"

src/main/rules/GCI12/javascript/GCI12.asciidoc

@@ -10,17 +10,22 @@ Making multiple CSS changes in a single batch can trigger multiple reflows and r
 Reflows and repaints are resource-intensive operations that can lead to performance issues.
 Applying changes individually minimizes the number of reflows and repaints, improving overall page performance.
 
+== How to fix it
+=== Noncompliant code example
+
 Here's an example in JavaScript and CSS to illustrate this rule:
 
 [source,html,data-diff-id="3",data-diff-type="noncompliant"]
 ----
 <script>
   element.style.height = "800px";
-  element.style.width = "600px"; // Non-compliant
-  element.style.color = "red"; // Non-compliant
+  element.style.width = "600px"; // Noncompliant
+  element.style.color = "red"; // Noncompliant
 </script>
 ----
 
+=== Compliant solution
+
 [source,html,data-diff-id="10",data-diff-type="compliant"]
 ----
 <style>
@@ -42,4 +47,4 @@ In the first example, multiple CSS properties are set in a single batch, while i
 
 === Documentation
 
-- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CNUMR best practices] - Modify several CSS properties at once
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CNumR best practices] - Modify several CSS properties at once