Merge pull request #75 from vincent314/feature/rename-rules

chore: rename rule keys ECXXX to the Green Code Initiative naming convention GCIXXX

Author: dedece35

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - [#59](https://github.com/green-code-initiative/ecoCode-java/pull/59) Add builtin profile `ecoCode way` to aggregate all implemented ecoCode rules by this plugin
 - [#53](https://github.com/green-code-initiative/ecoCode-java/issues/53) Improve integration tests
+- Rename rules ECXXX to the new Green Code Initiative naming convention GCIXXX
 
 ### Changed
 

pom.xml

@@ -10,7 +10,7 @@
 
     <name>ecoCode - Java language</name>
     <description>Provides rules to reduce the environmental footprint of your Java programs</description>
-    <inceptionYear>2023</inceptionYear>
+    <inceptionYear>2024</inceptionYear>
 
     <url>https://github.com/green-code-initiative/ecoCode-java</url>
     <organization>
@@ -71,8 +71,8 @@
 
         <google.re2j>1.7</google.re2j>
 
-        <!-- Version of ecoCode rules specifications implemented by this plugin -->
-        <ecocode-rules-specifications.version>1.6.5</ecocode-rules-specifications.version>
+        <!-- Version of creedengo rules specifications implemented by this plugin -->
+        <creedengo-rules-specifications.version>2.0.0</creedengo-rules-specifications.version>
 
         <!-- URL of the Maven repository where sonarqube will be downloaded -->
         <test-it.orchestrator.artifactory.url>https://repo1.maven.org/maven2</test-it.orchestrator.artifactory.url>
@@ -91,9 +91,9 @@
 
     <dependencies>
         <dependency>
-            <groupId>${project.groupId}</groupId>
-            <artifactId>ecocode-rules-specifications</artifactId>
-            <version>${ecocode-rules-specifications.version}</version>
+            <groupId>org.green-code-initiative</groupId>
+            <artifactId>creedengo-rules-specifications</artifactId>
+            <version>${creedengo-rules-specifications.version}</version>
             <classifier>java</classifier>
         </dependency>
 
@@ -238,7 +238,7 @@
                 <extensions>true</extensions>
                 <configuration>
                     <pluginKey>ecocodejava</pluginKey>
-                    <pluginClass>fr.greencodeinitiative.java.JavaPlugin</pluginClass>
+                    <pluginClass>org.greencodeinitiative.java.JavaPlugin</pluginClass>
                     <sonarLintSupported>true</sonarLintSupported>
                     <pluginApiMinVersion>${sonarqube.version}</pluginApiMinVersion>
                     <skipDependenciesPackaging>true</skipDependenciesPackaging>
@@ -470,7 +470,7 @@
                                 </test-it.plugins>
                                 <!-- Comma separated JSON profile file URIs to load -->
                                 <test-it.additional-profile-uris>
-                                    ${project.baseUri}/src/main/resources/fr/greencodeinitiative/java/ecoCode_way_profile.json,
+                                    ${project.baseUri}/src/main/resources/org/greencodeinitiative/java/ecoCode_way_profile.json,
                                 </test-it.additional-profile-uris>
                                 <!-- Comma separated paths of "test projects" to analyze. Syntaxe: `sonar.projectKey|sonar.projectName|project.pomUri` -->
                                 <test-it.test-projects>

src/it/java/io/ecocode/java/integration/tests/LaunchSonarqubeAndBuildProjectIT.java

@@ -141,7 +141,7 @@ void test() {
 		assertThat(issuesForArrayCopyCheck)
 				.hasSize(1)
 				.first().satisfies(issue -> {
-					assertThat(issue.getRule()).isEqualTo("ecocode-java:EC69");
+					assertThat(issue.getRule()).isEqualTo("ecocode-java:GCI69");
 					assertThat(issue.getSeverity()).isEqualTo(MINOR);
 					assertThat(issue.getLine()).isEqualTo(18);
 					assertThat(issue.getTextRange().getStartLine()).isEqualTo(18);
@@ -445,4 +445,4 @@ private static WsClient newWsClient(Orchestrator orchestrator) {
 		                                                             .url(orchestrator.getServer().getUrl())
 		                                                             .build());
 	}
-}
+}

src/it/java/io/ecocode/java/integration/tests/profile/ProfileBackup.java

@@ -22,8 +22,8 @@
  *  "name": "ecoCode way",
  *  "language": "java",
  *  "ruleKeys": [
- * 	    "EC1",
- * 	    "EC2"
+ * 	    "GCI1",
+ * 	    "GCI2"
  *  ]
  * }
  * </pre>
@@ -36,14 +36,14 @@
  * 	&lt;rules&gt;
  * 		&lt;rule&gt;
  * 			&lt;repositoryKey&gt;ecocode-java&lt;/repositoryKey&gt;
- * 			&lt;key&gt;EC1&lt;/key&gt;
+ * 			&lt;key&gt;GCI1&lt;/key&gt;
  * 			&lt;type&gt;CODE_SMELL&lt;/type&gt;
  * 			&lt;priority&gt;MINOR&lt;/priority&gt;
  * 			&lt;parameters /&gt;
  * 		&lt;/rule&gt;
  * 		&lt;rule&gt;
  * 			&lt;repositoryKey&gt;ecocode-java&lt;/repositoryKey&gt;
- * 			&lt;key&gt;EC2&lt;/key&gt;
+ * 			&lt;key&gt;GCI2&lt;/key&gt;
  * 			&lt;type&gt;CODE_SMELL&lt;/type&gt;
  * 			&lt;priority&gt;MINOR&lt;/priority&gt;
  * 			&lt;parameters /&gt;
@@ -160,4 +160,4 @@ public String language() {
 	public String name() {
 		return profileMetadata().getName();
 	}
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/ArrayCopyCheck.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 import java.util.Arrays;
 
@@ -490,4 +490,4 @@ private boolean transform(boolean a) {
         return !a;
     }
 
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/AvoidFullSQLRequestCheck.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 class AvoidFullSQLRequestCheck {
     AvoidFullSQLRequestCheck(AvoidFullSQLRequestCheck mc) {
@@ -27,4 +27,4 @@ private void dummyCall(String request) {
 
     }
 
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/AvoidGettingSizeCollectionInForEachLoopIgnored.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -18,4 +18,4 @@ public void ignoredLoop() {
             System.out.println("numberList.size()");
         }
     }
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/AvoidGettingSizeCollectionInForLoopBad.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -17,4 +17,4 @@ public void badForLoop() {
             System.out.println("numberList.size()");
         }
     }
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/AvoidGettingSizeCollectionInForLoopGood.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 import java.util.Collection;
 import java.util.ArrayList;
@@ -20,4 +20,4 @@ public void goodForLoop() {
             int size2 = numberList.size(); // Compliant with this rule
         }
     }
-}
+}

src/it/test-projects/ecocode-java-plugin-test-project/src/main/java/fr/greencodeinitiative/java/checks/AvoidGettingSizeCollectionInForLoopIgnored.java

@@ -1,4 +1,4 @@
-package fr.greencodeinitiative.java.checks;
+package org.greencodeinitiative.java.checks;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -20,4 +20,4 @@ public void badForLoop() {
             System.out.println("numberList.size()");
         }
     }
-}
+}